1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/kernel.h>
3 #include <linux/errno.h>
4 #include <linux/init.h>
5 #include <linux/slab.h>
7 #include <linux/module.h>
8 #include <linux/moduleparam.h>
9 #include <linux/scatterlist.h>
10 #include <linux/mutex.h>
11 #include <linux/timer.h>
12 #include <linux/usb.h>
14 #define SIMPLE_IO_TIMEOUT 10000 /* in milliseconds */
16 /*-------------------------------------------------------------------------*/
18 static int override_alt
= -1;
19 module_param_named(alt
, override_alt
, int, 0644);
20 MODULE_PARM_DESC(alt
, ">= 0 to override altsetting selection");
21 static void complicated_callback(struct urb
*urb
);
23 /*-------------------------------------------------------------------------*/
25 /* FIXME make these public somewhere; usbdevfs.h? */
27 /* Parameter for usbtest driver. */
28 struct usbtest_param_32
{
30 __u32 test_num
; /* 0..(TEST_CASES-1) */
42 * Compat parameter to the usbtest driver.
43 * This supports older user space binaries compiled with 64 bit compiler.
45 struct usbtest_param_64
{
47 __u32 test_num
; /* 0..(TEST_CASES-1) */
58 /* IOCTL interface to the driver. */
59 #define USBTEST_REQUEST_32 _IOWR('U', 100, struct usbtest_param_32)
60 /* COMPAT IOCTL interface to the driver. */
61 #define USBTEST_REQUEST_64 _IOWR('U', 100, struct usbtest_param_64)
63 /*-------------------------------------------------------------------------*/
65 #define GENERIC /* let probe() bind using module params */
67 /* Some devices that can be used for testing will have "real" drivers.
68 * Entries for those need to be enabled here by hand, after disabling
71 //#define IBOT2 /* grab iBOT2 webcams */
72 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
74 /*-------------------------------------------------------------------------*/
78 u8 ep_in
; /* bulk/intr source */
79 u8 ep_out
; /* bulk/intr sink */
82 unsigned iso
:1; /* try iso in/out */
83 unsigned intr
:1; /* try interrupt in/out */
87 /* this is accessed only through usbfs ioctl calls.
88 * one ioctl to issue a test ... one lock per device.
89 * tests create other threads if they need them.
90 * urbs and buffers are allocated dynamically,
91 * and data generated deterministically.
94 struct usb_interface
*intf
;
95 struct usbtest_info
*info
;
102 struct usb_endpoint_descriptor
*iso_in
, *iso_out
;
103 struct usb_endpoint_descriptor
*int_in
, *int_out
;
106 #define TBUF_SIZE 256
110 static struct usb_device
*testdev_to_usbdev(struct usbtest_dev
*test
)
112 return interface_to_usbdev(test
->intf
);
115 /* set up all urbs so they can be used with either bulk or interrupt */
116 #define INTERRUPT_RATE 1 /* msec/transfer */
118 #define ERROR(tdev, fmt, args...) \
119 dev_err(&(tdev)->intf->dev , fmt , ## args)
120 #define WARNING(tdev, fmt, args...) \
121 dev_warn(&(tdev)->intf->dev , fmt , ## args)
123 #define GUARD_BYTE 0xA5
124 #define MAX_SGLEN 128
126 /*-------------------------------------------------------------------------*/
128 static inline void endpoint_update(int edi
,
129 struct usb_host_endpoint
**in
,
130 struct usb_host_endpoint
**out
,
131 struct usb_host_endpoint
*e
)
143 get_endpoints(struct usbtest_dev
*dev
, struct usb_interface
*intf
)
146 struct usb_host_interface
*alt
;
147 struct usb_host_endpoint
*in
, *out
;
148 struct usb_host_endpoint
*iso_in
, *iso_out
;
149 struct usb_host_endpoint
*int_in
, *int_out
;
150 struct usb_device
*udev
;
152 for (tmp
= 0; tmp
< intf
->num_altsetting
; tmp
++) {
156 iso_in
= iso_out
= NULL
;
157 int_in
= int_out
= NULL
;
158 alt
= intf
->altsetting
+ tmp
;
160 if (override_alt
>= 0 &&
161 override_alt
!= alt
->desc
.bAlternateSetting
)
164 /* take the first altsetting with in-bulk + out-bulk;
165 * ignore other endpoints and altsettings.
167 for (ep
= 0; ep
< alt
->desc
.bNumEndpoints
; ep
++) {
168 struct usb_host_endpoint
*e
;
171 e
= alt
->endpoint
+ ep
;
172 edi
= usb_endpoint_dir_in(&e
->desc
);
174 switch (usb_endpoint_type(&e
->desc
)) {
175 case USB_ENDPOINT_XFER_BULK
:
176 endpoint_update(edi
, &in
, &out
, e
);
178 case USB_ENDPOINT_XFER_INT
:
180 endpoint_update(edi
, &int_in
, &int_out
, e
);
182 case USB_ENDPOINT_XFER_ISOC
:
184 endpoint_update(edi
, &iso_in
, &iso_out
, e
);
190 if ((in
&& out
) || iso_in
|| iso_out
|| int_in
|| int_out
)
196 udev
= testdev_to_usbdev(dev
);
197 dev
->info
->alt
= alt
->desc
.bAlternateSetting
;
198 if (alt
->desc
.bAlternateSetting
!= 0) {
199 tmp
= usb_set_interface(udev
,
200 alt
->desc
.bInterfaceNumber
,
201 alt
->desc
.bAlternateSetting
);
207 dev
->in_pipe
= usb_rcvbulkpipe(udev
,
208 in
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
210 dev
->out_pipe
= usb_sndbulkpipe(udev
,
211 out
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
214 dev
->iso_in
= &iso_in
->desc
;
215 dev
->in_iso_pipe
= usb_rcvisocpipe(udev
,
216 iso_in
->desc
.bEndpointAddress
217 & USB_ENDPOINT_NUMBER_MASK
);
221 dev
->iso_out
= &iso_out
->desc
;
222 dev
->out_iso_pipe
= usb_sndisocpipe(udev
,
223 iso_out
->desc
.bEndpointAddress
224 & USB_ENDPOINT_NUMBER_MASK
);
228 dev
->int_in
= &int_in
->desc
;
229 dev
->in_int_pipe
= usb_rcvintpipe(udev
,
230 int_in
->desc
.bEndpointAddress
231 & USB_ENDPOINT_NUMBER_MASK
);
235 dev
->int_out
= &int_out
->desc
;
236 dev
->out_int_pipe
= usb_sndintpipe(udev
,
237 int_out
->desc
.bEndpointAddress
238 & USB_ENDPOINT_NUMBER_MASK
);
243 /*-------------------------------------------------------------------------*/
245 /* Support for testing basic non-queued I/O streams.
247 * These just package urbs as requests that can be easily canceled.
248 * Each urb's data buffer is dynamically allocated; callers can fill
249 * them with non-zero test data (or test for it) when appropriate.
252 static void simple_callback(struct urb
*urb
)
254 complete(urb
->context
);
257 static struct urb
*usbtest_alloc_urb(
258 struct usb_device
*udev
,
261 unsigned transfer_flags
,
264 usb_complete_t complete_fn
)
268 urb
= usb_alloc_urb(0, GFP_KERNEL
);
273 usb_fill_int_urb(urb
, udev
, pipe
, NULL
, bytes
, complete_fn
,
276 usb_fill_bulk_urb(urb
, udev
, pipe
, NULL
, bytes
, complete_fn
,
279 urb
->interval
= (udev
->speed
== USB_SPEED_HIGH
)
280 ? (INTERRUPT_RATE
<< 3)
282 urb
->transfer_flags
= transfer_flags
;
283 if (usb_pipein(pipe
))
284 urb
->transfer_flags
|= URB_SHORT_NOT_OK
;
286 if ((bytes
+ offset
) == 0)
289 if (urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
)
290 urb
->transfer_buffer
= usb_alloc_coherent(udev
, bytes
+ offset
,
291 GFP_KERNEL
, &urb
->transfer_dma
);
293 urb
->transfer_buffer
= kmalloc(bytes
+ offset
, GFP_KERNEL
);
295 if (!urb
->transfer_buffer
) {
300 /* To test unaligned transfers add an offset and fill the
301 unused memory with a guard value */
303 memset(urb
->transfer_buffer
, GUARD_BYTE
, offset
);
304 urb
->transfer_buffer
+= offset
;
305 if (urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
)
306 urb
->transfer_dma
+= offset
;
309 /* For inbound transfers use guard byte so that test fails if
310 data not correctly copied */
311 memset(urb
->transfer_buffer
,
312 usb_pipein(urb
->pipe
) ? GUARD_BYTE
: 0,
317 static struct urb
*simple_alloc_urb(
318 struct usb_device
*udev
,
323 return usbtest_alloc_urb(udev
, pipe
, bytes
, URB_NO_TRANSFER_DMA_MAP
, 0,
324 bInterval
, simple_callback
);
327 static struct urb
*complicated_alloc_urb(
328 struct usb_device
*udev
,
333 return usbtest_alloc_urb(udev
, pipe
, bytes
, URB_NO_TRANSFER_DMA_MAP
, 0,
334 bInterval
, complicated_callback
);
337 static unsigned pattern
;
338 static unsigned mod_pattern
;
339 module_param_named(pattern
, mod_pattern
, uint
, S_IRUGO
| S_IWUSR
);
340 MODULE_PARM_DESC(mod_pattern
, "i/o pattern (0 == zeroes)");
342 static unsigned get_maxpacket(struct usb_device
*udev
, int pipe
)
344 struct usb_host_endpoint
*ep
;
346 ep
= usb_pipe_endpoint(udev
, pipe
);
347 return le16_to_cpup(&ep
->desc
.wMaxPacketSize
);
350 static void simple_fill_buf(struct urb
*urb
)
353 u8
*buf
= urb
->transfer_buffer
;
354 unsigned len
= urb
->transfer_buffer_length
;
364 maxpacket
= get_maxpacket(urb
->dev
, urb
->pipe
);
365 for (i
= 0; i
< len
; i
++)
366 *buf
++ = (u8
) ((i
% maxpacket
) % 63);
371 static inline unsigned long buffer_offset(void *buf
)
373 return (unsigned long)buf
& (ARCH_KMALLOC_MINALIGN
- 1);
376 static int check_guard_bytes(struct usbtest_dev
*tdev
, struct urb
*urb
)
378 u8
*buf
= urb
->transfer_buffer
;
379 u8
*guard
= buf
- buffer_offset(buf
);
382 for (i
= 0; guard
< buf
; i
++, guard
++) {
383 if (*guard
!= GUARD_BYTE
) {
384 ERROR(tdev
, "guard byte[%d] %d (not %d)\n",
385 i
, *guard
, GUARD_BYTE
);
392 static int simple_check_buf(struct usbtest_dev
*tdev
, struct urb
*urb
)
396 u8
*buf
= urb
->transfer_buffer
;
397 unsigned len
= urb
->actual_length
;
398 unsigned maxpacket
= get_maxpacket(urb
->dev
, urb
->pipe
);
400 int ret
= check_guard_bytes(tdev
, urb
);
404 for (i
= 0; i
< len
; i
++, buf
++) {
406 /* all-zeroes has no synchronization issues */
410 /* mod63 stays in sync with short-terminated transfers,
411 * or otherwise when host and gadget agree on how large
412 * each usb transfer request should be. resync is done
413 * with set_interface or set_config.
416 expected
= (i
% maxpacket
) % 63;
418 /* always fail unsupported patterns */
423 if (*buf
== expected
)
425 ERROR(tdev
, "buf[%d] = %d (not %d)\n", i
, *buf
, expected
);
431 static void simple_free_urb(struct urb
*urb
)
433 unsigned long offset
= buffer_offset(urb
->transfer_buffer
);
435 if (urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
)
438 urb
->transfer_buffer_length
+ offset
,
439 urb
->transfer_buffer
- offset
,
440 urb
->transfer_dma
- offset
);
442 kfree(urb
->transfer_buffer
- offset
);
446 static int simple_io(
447 struct usbtest_dev
*tdev
,
455 struct usb_device
*udev
= urb
->dev
;
456 int max
= urb
->transfer_buffer_length
;
457 struct completion completion
;
459 unsigned long expire
;
461 urb
->context
= &completion
;
462 while (retval
== 0 && iterations
-- > 0) {
463 init_completion(&completion
);
464 if (usb_pipeout(urb
->pipe
)) {
465 simple_fill_buf(urb
);
466 urb
->transfer_flags
|= URB_ZERO_PACKET
;
468 retval
= usb_submit_urb(urb
, GFP_KERNEL
);
472 expire
= msecs_to_jiffies(SIMPLE_IO_TIMEOUT
);
473 if (!wait_for_completion_timeout(&completion
, expire
)) {
475 retval
= (urb
->status
== -ENOENT
?
476 -ETIMEDOUT
: urb
->status
);
478 retval
= urb
->status
;
482 if (retval
== 0 && usb_pipein(urb
->pipe
))
483 retval
= simple_check_buf(tdev
, urb
);
486 int len
= urb
->transfer_buffer_length
;
491 len
= (vary
< max
) ? vary
: max
;
492 urb
->transfer_buffer_length
= len
;
495 /* FIXME if endpoint halted, clear halt (and log) */
497 urb
->transfer_buffer_length
= max
;
499 if (expected
!= retval
)
501 "%s failed, iterations left %d, status %d (not %d)\n",
502 label
, iterations
, retval
, expected
);
507 /*-------------------------------------------------------------------------*/
509 /* We use scatterlist primitives to test queued I/O.
510 * Yes, this also tests the scatterlist primitives.
513 static void free_sglist(struct scatterlist
*sg
, int nents
)
519 for (i
= 0; i
< nents
; i
++) {
520 if (!sg_page(&sg
[i
]))
522 kfree(sg_virt(&sg
[i
]));
527 static struct scatterlist
*
528 alloc_sglist(int nents
, int max
, int vary
, struct usbtest_dev
*dev
, int pipe
)
530 struct scatterlist
*sg
;
531 unsigned int n_size
= 0;
535 get_maxpacket(interface_to_usbdev(dev
->intf
), pipe
);
540 sg
= kmalloc_array(nents
, sizeof(*sg
), GFP_KERNEL
);
543 sg_init_table(sg
, nents
);
545 for (i
= 0; i
< nents
; i
++) {
549 buf
= kzalloc(size
, GFP_KERNEL
);
555 /* kmalloc pages are always physically contiguous! */
556 sg_set_buf(&sg
[i
], buf
, size
);
563 for (j
= 0; j
< size
; j
++)
564 *buf
++ = (u8
) (((j
+ n_size
) % maxpacket
) % 63);
573 size
= (vary
< max
) ? vary
: max
;
581 struct timer_list timer
;
582 struct usb_sg_request
*req
;
585 static void sg_timeout(struct timer_list
*t
)
587 struct sg_timeout
*timeout
= from_timer(timeout
, t
, timer
);
589 usb_sg_cancel(timeout
->req
);
592 static int perform_sglist(
593 struct usbtest_dev
*tdev
,
596 struct usb_sg_request
*req
,
597 struct scatterlist
*sg
,
601 struct usb_device
*udev
= testdev_to_usbdev(tdev
);
603 struct sg_timeout timeout
= {
607 timer_setup_on_stack(&timeout
.timer
, sg_timeout
, 0);
609 while (retval
== 0 && iterations
-- > 0) {
610 retval
= usb_sg_init(req
, udev
, pipe
,
611 (udev
->speed
== USB_SPEED_HIGH
)
612 ? (INTERRUPT_RATE
<< 3)
614 sg
, nents
, 0, GFP_KERNEL
);
618 mod_timer(&timeout
.timer
, jiffies
+
619 msecs_to_jiffies(SIMPLE_IO_TIMEOUT
));
621 if (!del_timer_sync(&timeout
.timer
))
624 retval
= req
->status
;
625 destroy_timer_on_stack(&timeout
.timer
);
627 /* FIXME check resulting data pattern */
629 /* FIXME if endpoint halted, clear halt (and log) */
632 /* FIXME for unlink or fault handling tests, don't report
633 * failure if retval is as we expected ...
636 ERROR(tdev
, "perform_sglist failed, "
637 "iterations left %d, status %d\n",
643 /*-------------------------------------------------------------------------*/
645 /* unqueued control message testing
647 * there's a nice set of device functional requirements in chapter 9 of the
648 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
649 * special test firmware.
651 * we know the device is configured (or suspended) by the time it's visible
652 * through usbfs. we can't change that, so we won't test enumeration (which
653 * worked 'well enough' to get here, this time), power management (ditto),
654 * or remote wakeup (which needs human interaction).
657 static unsigned realworld
= 1;
658 module_param(realworld
, uint
, 0);
659 MODULE_PARM_DESC(realworld
, "clear to demand stricter spec compliance");
661 static int get_altsetting(struct usbtest_dev
*dev
)
663 struct usb_interface
*iface
= dev
->intf
;
664 struct usb_device
*udev
= interface_to_usbdev(iface
);
667 retval
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
668 USB_REQ_GET_INTERFACE
, USB_DIR_IN
|USB_RECIP_INTERFACE
,
669 0, iface
->altsetting
[0].desc
.bInterfaceNumber
,
670 dev
->buf
, 1, USB_CTRL_GET_TIMEOUT
);
682 static int set_altsetting(struct usbtest_dev
*dev
, int alternate
)
684 struct usb_interface
*iface
= dev
->intf
;
685 struct usb_device
*udev
;
687 if (alternate
< 0 || alternate
>= 256)
690 udev
= interface_to_usbdev(iface
);
691 return usb_set_interface(udev
,
692 iface
->altsetting
[0].desc
.bInterfaceNumber
,
696 static int is_good_config(struct usbtest_dev
*tdev
, int len
)
698 struct usb_config_descriptor
*config
;
700 if (len
< sizeof(*config
))
702 config
= (struct usb_config_descriptor
*) tdev
->buf
;
704 switch (config
->bDescriptorType
) {
706 case USB_DT_OTHER_SPEED_CONFIG
:
707 if (config
->bLength
!= 9) {
708 ERROR(tdev
, "bogus config descriptor length\n");
711 /* this bit 'must be 1' but often isn't */
712 if (!realworld
&& !(config
->bmAttributes
& 0x80)) {
713 ERROR(tdev
, "high bit of config attributes not set\n");
716 if (config
->bmAttributes
& 0x1f) { /* reserved == 0 */
717 ERROR(tdev
, "reserved config bits set\n");
725 if (le16_to_cpu(config
->wTotalLength
) == len
) /* read it all */
727 if (le16_to_cpu(config
->wTotalLength
) >= TBUF_SIZE
) /* max partial read */
729 ERROR(tdev
, "bogus config descriptor read size\n");
733 static int is_good_ext(struct usbtest_dev
*tdev
, u8
*buf
)
735 struct usb_ext_cap_descriptor
*ext
;
738 ext
= (struct usb_ext_cap_descriptor
*) buf
;
740 if (ext
->bLength
!= USB_DT_USB_EXT_CAP_SIZE
) {
741 ERROR(tdev
, "bogus usb 2.0 extension descriptor length\n");
745 attr
= le32_to_cpu(ext
->bmAttributes
);
746 /* bits[1:15] is used and others are reserved */
747 if (attr
& ~0xfffe) { /* reserved == 0 */
748 ERROR(tdev
, "reserved bits set\n");
755 static int is_good_ss_cap(struct usbtest_dev
*tdev
, u8
*buf
)
757 struct usb_ss_cap_descriptor
*ss
;
759 ss
= (struct usb_ss_cap_descriptor
*) buf
;
761 if (ss
->bLength
!= USB_DT_USB_SS_CAP_SIZE
) {
762 ERROR(tdev
, "bogus superspeed device capability descriptor length\n");
767 * only bit[1] of bmAttributes is used for LTM and others are
770 if (ss
->bmAttributes
& ~0x02) { /* reserved == 0 */
771 ERROR(tdev
, "reserved bits set in bmAttributes\n");
775 /* bits[0:3] of wSpeedSupported is used and others are reserved */
776 if (le16_to_cpu(ss
->wSpeedSupported
) & ~0x0f) { /* reserved == 0 */
777 ERROR(tdev
, "reserved bits set in wSpeedSupported\n");
784 static int is_good_con_id(struct usbtest_dev
*tdev
, u8
*buf
)
786 struct usb_ss_container_id_descriptor
*con_id
;
788 con_id
= (struct usb_ss_container_id_descriptor
*) buf
;
790 if (con_id
->bLength
!= USB_DT_USB_SS_CONTN_ID_SIZE
) {
791 ERROR(tdev
, "bogus container id descriptor length\n");
795 if (con_id
->bReserved
) { /* reserved == 0 */
796 ERROR(tdev
, "reserved bits set\n");
803 /* sanity test for standard requests working with usb_control_mesg() and some
804 * of the utility functions which use it.
806 * this doesn't test how endpoint halts behave or data toggles get set, since
807 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
808 * halt or toggle). toggle testing is impractical without support from hcds.
810 * this avoids failing devices linux would normally work with, by not testing
811 * config/altsetting operations for devices that only support their defaults.
812 * such devices rarely support those needless operations.
814 * NOTE that since this is a sanity test, it's not examining boundary cases
815 * to see if usbcore, hcd, and device all behave right. such testing would
816 * involve varied read sizes and other operation sequences.
818 static int ch9_postconfig(struct usbtest_dev
*dev
)
820 struct usb_interface
*iface
= dev
->intf
;
821 struct usb_device
*udev
= interface_to_usbdev(iface
);
824 /* [9.2.3] if there's more than one altsetting, we need to be able to
825 * set and get each one. mostly trusts the descriptors from usbcore.
827 for (i
= 0; i
< iface
->num_altsetting
; i
++) {
829 /* 9.2.3 constrains the range here */
830 alt
= iface
->altsetting
[i
].desc
.bAlternateSetting
;
831 if (alt
< 0 || alt
>= iface
->num_altsetting
) {
833 "invalid alt [%d].bAltSetting = %d\n",
837 /* [real world] get/set unimplemented if there's only one */
838 if (realworld
&& iface
->num_altsetting
== 1)
841 /* [9.4.10] set_interface */
842 retval
= set_altsetting(dev
, alt
);
844 dev_err(&iface
->dev
, "can't set_interface = %d, %d\n",
849 /* [9.4.4] get_interface always works */
850 retval
= get_altsetting(dev
);
852 dev_err(&iface
->dev
, "get alt should be %d, was %d\n",
854 return (retval
< 0) ? retval
: -EDOM
;
859 /* [real world] get_config unimplemented if there's only one */
860 if (!realworld
|| udev
->descriptor
.bNumConfigurations
!= 1) {
861 int expected
= udev
->actconfig
->desc
.bConfigurationValue
;
863 /* [9.4.2] get_configuration always works
864 * ... although some cheap devices (like one TI Hub I've got)
865 * won't return config descriptors except before set_config.
867 retval
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
868 USB_REQ_GET_CONFIGURATION
,
869 USB_DIR_IN
| USB_RECIP_DEVICE
,
870 0, 0, dev
->buf
, 1, USB_CTRL_GET_TIMEOUT
);
871 if (retval
!= 1 || dev
->buf
[0] != expected
) {
872 dev_err(&iface
->dev
, "get config --> %d %d (1 %d)\n",
873 retval
, dev
->buf
[0], expected
);
874 return (retval
< 0) ? retval
: -EDOM
;
878 /* there's always [9.4.3] a device descriptor [9.6.1] */
879 retval
= usb_get_descriptor(udev
, USB_DT_DEVICE
, 0,
880 dev
->buf
, sizeof(udev
->descriptor
));
881 if (retval
!= sizeof(udev
->descriptor
)) {
882 dev_err(&iface
->dev
, "dev descriptor --> %d\n", retval
);
883 return (retval
< 0) ? retval
: -EDOM
;
887 * there's always [9.4.3] a bos device descriptor [9.6.2] in USB
890 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) >= 0x0210) {
891 struct usb_bos_descriptor
*bos
= NULL
;
892 struct usb_dev_cap_header
*header
= NULL
;
893 unsigned total
, num
, length
;
896 retval
= usb_get_descriptor(udev
, USB_DT_BOS
, 0, dev
->buf
,
897 sizeof(*udev
->bos
->desc
));
898 if (retval
!= sizeof(*udev
->bos
->desc
)) {
899 dev_err(&iface
->dev
, "bos descriptor --> %d\n", retval
);
900 return (retval
< 0) ? retval
: -EDOM
;
903 bos
= (struct usb_bos_descriptor
*)dev
->buf
;
904 total
= le16_to_cpu(bos
->wTotalLength
);
905 num
= bos
->bNumDeviceCaps
;
907 if (total
> TBUF_SIZE
)
911 * get generic device-level capability descriptors [9.6.2]
914 retval
= usb_get_descriptor(udev
, USB_DT_BOS
, 0, dev
->buf
,
916 if (retval
!= total
) {
917 dev_err(&iface
->dev
, "bos descriptor set --> %d\n",
919 return (retval
< 0) ? retval
: -EDOM
;
922 length
= sizeof(*udev
->bos
->desc
);
924 for (i
= 0; i
< num
; i
++) {
926 if (buf
+ sizeof(struct usb_dev_cap_header
) >
930 header
= (struct usb_dev_cap_header
*)buf
;
931 length
= header
->bLength
;
933 if (header
->bDescriptorType
!=
934 USB_DT_DEVICE_CAPABILITY
) {
935 dev_warn(&udev
->dev
, "not device capability descriptor, skip\n");
939 switch (header
->bDevCapabilityType
) {
940 case USB_CAP_TYPE_EXT
:
941 if (buf
+ USB_DT_USB_EXT_CAP_SIZE
>
943 !is_good_ext(dev
, buf
)) {
944 dev_err(&iface
->dev
, "bogus usb 2.0 extension descriptor\n");
948 case USB_SS_CAP_TYPE
:
949 if (buf
+ USB_DT_USB_SS_CAP_SIZE
>
951 !is_good_ss_cap(dev
, buf
)) {
952 dev_err(&iface
->dev
, "bogus superspeed device capability descriptor\n");
956 case CONTAINER_ID_TYPE
:
957 if (buf
+ USB_DT_USB_SS_CONTN_ID_SIZE
>
959 !is_good_con_id(dev
, buf
)) {
960 dev_err(&iface
->dev
, "bogus container id descriptor\n");
970 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
971 for (i
= 0; i
< udev
->descriptor
.bNumConfigurations
; i
++) {
972 retval
= usb_get_descriptor(udev
, USB_DT_CONFIG
, i
,
973 dev
->buf
, TBUF_SIZE
);
974 if (!is_good_config(dev
, retval
)) {
976 "config [%d] descriptor --> %d\n",
978 return (retval
< 0) ? retval
: -EDOM
;
981 /* FIXME cross-checking udev->config[i] to make sure usbcore
982 * parsed it right (etc) would be good testing paranoia
986 /* and sometimes [9.2.6.6] speed dependent descriptors */
987 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) == 0x0200) {
988 struct usb_qualifier_descriptor
*d
= NULL
;
990 /* device qualifier [9.6.2] */
991 retval
= usb_get_descriptor(udev
,
992 USB_DT_DEVICE_QUALIFIER
, 0, dev
->buf
,
993 sizeof(struct usb_qualifier_descriptor
));
994 if (retval
== -EPIPE
) {
995 if (udev
->speed
== USB_SPEED_HIGH
) {
997 "hs dev qualifier --> %d\n",
1001 /* usb2.0 but not high-speed capable; fine */
1002 } else if (retval
!= sizeof(struct usb_qualifier_descriptor
)) {
1003 dev_err(&iface
->dev
, "dev qualifier --> %d\n", retval
);
1004 return (retval
< 0) ? retval
: -EDOM
;
1006 d
= (struct usb_qualifier_descriptor
*) dev
->buf
;
1008 /* might not have [9.6.2] any other-speed configs [9.6.4] */
1010 unsigned max
= d
->bNumConfigurations
;
1011 for (i
= 0; i
< max
; i
++) {
1012 retval
= usb_get_descriptor(udev
,
1013 USB_DT_OTHER_SPEED_CONFIG
, i
,
1014 dev
->buf
, TBUF_SIZE
);
1015 if (!is_good_config(dev
, retval
)) {
1016 dev_err(&iface
->dev
,
1017 "other speed config --> %d\n",
1019 return (retval
< 0) ? retval
: -EDOM
;
1024 /* FIXME fetch strings from at least the device descriptor */
1026 /* [9.4.5] get_status always works */
1027 retval
= usb_get_std_status(udev
, USB_RECIP_DEVICE
, 0, dev
->buf
);
1029 dev_err(&iface
->dev
, "get dev status --> %d\n", retval
);
1033 /* FIXME configuration.bmAttributes says if we could try to set/clear
1034 * the device's remote wakeup feature ... if we can, test that here
1037 retval
= usb_get_std_status(udev
, USB_RECIP_INTERFACE
,
1038 iface
->altsetting
[0].desc
.bInterfaceNumber
, dev
->buf
);
1040 dev_err(&iface
->dev
, "get interface status --> %d\n", retval
);
1043 /* FIXME get status for each endpoint in the interface */
1048 /*-------------------------------------------------------------------------*/
1050 /* use ch9 requests to test whether:
1051 * (a) queues work for control, keeping N subtests queued and
1052 * active (auto-resubmit) for M loops through the queue.
1053 * (b) protocol stalls (control-only) will autorecover.
1054 * it's not like bulk/intr; no halt clearing.
1055 * (c) short control reads are reported and handled.
1056 * (d) queues are always processed in-order
1061 struct usbtest_dev
*dev
;
1062 struct completion complete
;
1067 struct usbtest_param_32
*param
;
1071 #define NUM_SUBCASES 16 /* how many test subcases here? */
1074 struct usb_ctrlrequest setup
;
1079 static void ctrl_complete(struct urb
*urb
)
1081 struct ctrl_ctx
*ctx
= urb
->context
;
1082 struct usb_ctrlrequest
*reqp
;
1083 struct subcase
*subcase
;
1084 int status
= urb
->status
;
1086 reqp
= (struct usb_ctrlrequest
*)urb
->setup_packet
;
1087 subcase
= container_of(reqp
, struct subcase
, setup
);
1089 spin_lock(&ctx
->lock
);
1093 /* queue must transfer and complete in fifo order, unless
1094 * usb_unlink_urb() is used to unlink something not at the
1095 * physical queue head (not tested).
1097 if (subcase
->number
> 0) {
1098 if ((subcase
->number
- ctx
->last
) != 1) {
1100 "subcase %d completed out of order, last %d\n",
1101 subcase
->number
, ctx
->last
);
1103 ctx
->last
= subcase
->number
;
1107 ctx
->last
= subcase
->number
;
1109 /* succeed or fault in only one way? */
1110 if (status
== subcase
->expected
)
1113 /* async unlink for cleanup? */
1114 else if (status
!= -ECONNRESET
) {
1116 /* some faults are allowed, not required */
1117 if (subcase
->expected
> 0 && (
1118 ((status
== -subcase
->expected
/* happened */
1119 || status
== 0)))) /* didn't */
1121 /* sometimes more than one fault is allowed */
1122 else if (subcase
->number
== 12 && status
== -EPIPE
)
1125 ERROR(ctx
->dev
, "subtest %d error, status %d\n",
1126 subcase
->number
, status
);
1129 /* unexpected status codes mean errors; ideally, in hardware */
1132 if (ctx
->status
== 0) {
1135 ctx
->status
= status
;
1136 ERROR(ctx
->dev
, "control queue %02x.%02x, err %d, "
1137 "%d left, subcase %d, len %d/%d\n",
1138 reqp
->bRequestType
, reqp
->bRequest
,
1139 status
, ctx
->count
, subcase
->number
,
1141 urb
->transfer_buffer_length
);
1143 /* FIXME this "unlink everything" exit route should
1144 * be a separate test case.
1147 /* unlink whatever's still pending */
1148 for (i
= 1; i
< ctx
->param
->sglen
; i
++) {
1149 struct urb
*u
= ctx
->urb
[
1150 (i
+ subcase
->number
)
1151 % ctx
->param
->sglen
];
1153 if (u
== urb
|| !u
->dev
)
1155 spin_unlock(&ctx
->lock
);
1156 status
= usb_unlink_urb(u
);
1157 spin_lock(&ctx
->lock
);
1164 ERROR(ctx
->dev
, "urb unlink --> %d\n",
1168 status
= ctx
->status
;
1172 /* resubmit if we need to, else mark this as done */
1173 if ((status
== 0) && (ctx
->pending
< ctx
->count
)) {
1174 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
1177 "can't resubmit ctrl %02x.%02x, err %d\n",
1178 reqp
->bRequestType
, reqp
->bRequest
, status
);
1185 /* signal completion when nothing's queued */
1186 if (ctx
->pending
== 0)
1187 complete(&ctx
->complete
);
1188 spin_unlock(&ctx
->lock
);
1192 test_ctrl_queue(struct usbtest_dev
*dev
, struct usbtest_param_32
*param
)
1194 struct usb_device
*udev
= testdev_to_usbdev(dev
);
1196 struct ctrl_ctx context
;
1199 if (param
->sglen
== 0 || param
->iterations
> UINT_MAX
/ param
->sglen
)
1202 spin_lock_init(&context
.lock
);
1204 init_completion(&context
.complete
);
1205 context
.count
= param
->sglen
* param
->iterations
;
1206 context
.pending
= 0;
1207 context
.status
= -ENOMEM
;
1208 context
.param
= param
;
1211 /* allocate and init the urbs we'll queue.
1212 * as with bulk/intr sglists, sglen is the queue depth; it also
1213 * controls which subtests run (more tests than sglen) or rerun.
1215 urb
= kcalloc(param
->sglen
, sizeof(struct urb
*), GFP_KERNEL
);
1218 for (i
= 0; i
< param
->sglen
; i
++) {
1219 int pipe
= usb_rcvctrlpipe(udev
, 0);
1222 struct usb_ctrlrequest req
;
1223 struct subcase
*reqp
;
1225 /* sign of this variable means:
1226 * -: tested code must return this (negative) error code
1227 * +: tested code may return this (negative too) error code
1231 /* requests here are mostly expected to succeed on any
1232 * device, but some are chosen to trigger protocol stalls
1235 memset(&req
, 0, sizeof(req
));
1236 req
.bRequest
= USB_REQ_GET_DESCRIPTOR
;
1237 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_DEVICE
;
1239 switch (i
% NUM_SUBCASES
) {
1240 case 0: /* get device descriptor */
1241 req
.wValue
= cpu_to_le16(USB_DT_DEVICE
<< 8);
1242 len
= sizeof(struct usb_device_descriptor
);
1244 case 1: /* get first config descriptor (only) */
1245 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
1246 len
= sizeof(struct usb_config_descriptor
);
1248 case 2: /* get altsetting (OFTEN STALLS) */
1249 req
.bRequest
= USB_REQ_GET_INTERFACE
;
1250 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_INTERFACE
;
1251 /* index = 0 means first interface */
1255 case 3: /* get interface status */
1256 req
.bRequest
= USB_REQ_GET_STATUS
;
1257 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_INTERFACE
;
1261 case 4: /* get device status */
1262 req
.bRequest
= USB_REQ_GET_STATUS
;
1263 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_DEVICE
;
1266 case 5: /* get device qualifier (MAY STALL) */
1267 req
.wValue
= cpu_to_le16 (USB_DT_DEVICE_QUALIFIER
<< 8);
1268 len
= sizeof(struct usb_qualifier_descriptor
);
1269 if (udev
->speed
!= USB_SPEED_HIGH
)
1272 case 6: /* get first config descriptor, plus interface */
1273 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
1274 len
= sizeof(struct usb_config_descriptor
);
1275 len
+= sizeof(struct usb_interface_descriptor
);
1277 case 7: /* get interface descriptor (ALWAYS STALLS) */
1278 req
.wValue
= cpu_to_le16 (USB_DT_INTERFACE
<< 8);
1279 /* interface == 0 */
1280 len
= sizeof(struct usb_interface_descriptor
);
1283 /* NOTE: two consecutive stalls in the queue here.
1284 * that tests fault recovery a bit more aggressively. */
1285 case 8: /* clear endpoint halt (MAY STALL) */
1286 req
.bRequest
= USB_REQ_CLEAR_FEATURE
;
1287 req
.bRequestType
= USB_RECIP_ENDPOINT
;
1288 /* wValue 0 == ep halt */
1289 /* wIndex 0 == ep0 (shouldn't halt!) */
1291 pipe
= usb_sndctrlpipe(udev
, 0);
1294 case 9: /* get endpoint status */
1295 req
.bRequest
= USB_REQ_GET_STATUS
;
1296 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_ENDPOINT
;
1300 case 10: /* trigger short read (EREMOTEIO) */
1301 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
1303 expected
= -EREMOTEIO
;
1305 /* NOTE: two consecutive _different_ faults in the queue. */
1306 case 11: /* get endpoint descriptor (ALWAYS STALLS) */
1307 req
.wValue
= cpu_to_le16(USB_DT_ENDPOINT
<< 8);
1309 len
= sizeof(struct usb_interface_descriptor
);
1312 /* NOTE: sometimes even a third fault in the queue! */
1313 case 12: /* get string 0 descriptor (MAY STALL) */
1314 req
.wValue
= cpu_to_le16(USB_DT_STRING
<< 8);
1315 /* string == 0, for language IDs */
1316 len
= sizeof(struct usb_interface_descriptor
);
1317 /* may succeed when > 4 languages */
1318 expected
= EREMOTEIO
; /* or EPIPE, if no strings */
1320 case 13: /* short read, resembling case 10 */
1321 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
1322 /* last data packet "should" be DATA1, not DATA0 */
1323 if (udev
->speed
== USB_SPEED_SUPER
)
1326 len
= 1024 - udev
->descriptor
.bMaxPacketSize0
;
1327 expected
= -EREMOTEIO
;
1329 case 14: /* short read; try to fill the last packet */
1330 req
.wValue
= cpu_to_le16((USB_DT_DEVICE
<< 8) | 0);
1331 /* device descriptor size == 18 bytes */
1332 len
= udev
->descriptor
.bMaxPacketSize0
;
1333 if (udev
->speed
== USB_SPEED_SUPER
)
1343 expected
= -EREMOTEIO
;
1346 req
.wValue
= cpu_to_le16(USB_DT_BOS
<< 8);
1348 len
= le16_to_cpu(udev
->bos
->desc
->wTotalLength
);
1350 len
= sizeof(struct usb_bos_descriptor
);
1351 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) < 0x0201)
1355 ERROR(dev
, "bogus number of ctrl queue testcases!\n");
1356 context
.status
= -EINVAL
;
1359 req
.wLength
= cpu_to_le16(len
);
1360 urb
[i
] = u
= simple_alloc_urb(udev
, pipe
, len
, 0);
1364 reqp
= kmalloc(sizeof(*reqp
), GFP_KERNEL
);
1368 reqp
->number
= i
% NUM_SUBCASES
;
1369 reqp
->expected
= expected
;
1370 u
->setup_packet
= (char *) &reqp
->setup
;
1372 u
->context
= &context
;
1373 u
->complete
= ctrl_complete
;
1376 /* queue the urbs */
1378 spin_lock_irq(&context
.lock
);
1379 for (i
= 0; i
< param
->sglen
; i
++) {
1380 context
.status
= usb_submit_urb(urb
[i
], GFP_ATOMIC
);
1381 if (context
.status
!= 0) {
1382 ERROR(dev
, "can't submit urb[%d], status %d\n",
1384 context
.count
= context
.pending
;
1389 spin_unlock_irq(&context
.lock
);
1391 /* FIXME set timer and time out; provide a disconnect hook */
1393 /* wait for the last one to complete */
1394 if (context
.pending
> 0)
1395 wait_for_completion(&context
.complete
);
1398 for (i
= 0; i
< param
->sglen
; i
++) {
1402 kfree(urb
[i
]->setup_packet
);
1403 simple_free_urb(urb
[i
]);
1406 return context
.status
;
1411 /*-------------------------------------------------------------------------*/
1413 static void unlink1_callback(struct urb
*urb
)
1415 int status
= urb
->status
;
1417 /* we "know" -EPIPE (stall) never happens */
1419 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
1421 urb
->status
= status
;
1422 complete(urb
->context
);
1426 static int unlink1(struct usbtest_dev
*dev
, int pipe
, int size
, int async
)
1429 struct completion completion
;
1432 init_completion(&completion
);
1433 urb
= simple_alloc_urb(testdev_to_usbdev(dev
), pipe
, size
, 0);
1436 urb
->context
= &completion
;
1437 urb
->complete
= unlink1_callback
;
1439 if (usb_pipeout(urb
->pipe
)) {
1440 simple_fill_buf(urb
);
1441 urb
->transfer_flags
|= URB_ZERO_PACKET
;
1444 /* keep the endpoint busy. there are lots of hc/hcd-internal
1445 * states, and testing should get to all of them over time.
1447 * FIXME want additional tests for when endpoint is STALLing
1448 * due to errors, or is just NAKing requests.
1450 retval
= usb_submit_urb(urb
, GFP_KERNEL
);
1452 dev_err(&dev
->intf
->dev
, "submit fail %d\n", retval
);
1456 /* unlinking that should always work. variable delay tests more
1457 * hcd states and code paths, even with little other system load.
1459 msleep(jiffies
% (2 * INTERRUPT_RATE
));
1461 while (!completion_done(&completion
)) {
1462 retval
= usb_unlink_urb(urb
);
1464 if (retval
== 0 && usb_pipein(urb
->pipe
))
1465 retval
= simple_check_buf(dev
, urb
);
1470 /* we can't unlink urbs while they're completing
1471 * or if they've completed, and we haven't
1472 * resubmitted. "normal" drivers would prevent
1473 * resubmission, but since we're testing unlink
1476 ERROR(dev
, "unlink retry\n");
1483 dev_err(&dev
->intf
->dev
,
1484 "unlink fail %d\n", retval
);
1493 wait_for_completion(&completion
);
1494 retval
= urb
->status
;
1495 simple_free_urb(urb
);
1498 return (retval
== -ECONNRESET
) ? 0 : retval
- 1000;
1500 return (retval
== -ENOENT
|| retval
== -EPERM
) ?
1504 static int unlink_simple(struct usbtest_dev
*dev
, int pipe
, int len
)
1508 /* test sync and async paths */
1509 retval
= unlink1(dev
, pipe
, len
, 1);
1511 retval
= unlink1(dev
, pipe
, len
, 0);
1515 /*-------------------------------------------------------------------------*/
1518 struct completion complete
;
1525 static void unlink_queued_callback(struct urb
*urb
)
1527 int status
= urb
->status
;
1528 struct queued_ctx
*ctx
= urb
->context
;
1532 if (urb
== ctx
->urbs
[ctx
->num
- 4] || urb
== ctx
->urbs
[ctx
->num
- 2]) {
1533 if (status
== -ECONNRESET
)
1535 /* What error should we report if the URB completed normally? */
1538 ctx
->status
= status
;
1541 if (atomic_dec_and_test(&ctx
->pending
))
1542 complete(&ctx
->complete
);
1545 static int unlink_queued(struct usbtest_dev
*dev
, int pipe
, unsigned num
,
1548 struct queued_ctx ctx
;
1549 struct usb_device
*udev
= testdev_to_usbdev(dev
);
1553 int retval
= -ENOMEM
;
1555 init_completion(&ctx
.complete
);
1556 atomic_set(&ctx
.pending
, 1); /* One more than the actual value */
1560 buf
= usb_alloc_coherent(udev
, size
, GFP_KERNEL
, &buf_dma
);
1563 memset(buf
, 0, size
);
1565 /* Allocate and init the urbs we'll queue */
1566 ctx
.urbs
= kcalloc(num
, sizeof(struct urb
*), GFP_KERNEL
);
1569 for (i
= 0; i
< num
; i
++) {
1570 ctx
.urbs
[i
] = usb_alloc_urb(0, GFP_KERNEL
);
1573 usb_fill_bulk_urb(ctx
.urbs
[i
], udev
, pipe
, buf
, size
,
1574 unlink_queued_callback
, &ctx
);
1575 ctx
.urbs
[i
]->transfer_dma
= buf_dma
;
1576 ctx
.urbs
[i
]->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
1578 if (usb_pipeout(ctx
.urbs
[i
]->pipe
)) {
1579 simple_fill_buf(ctx
.urbs
[i
]);
1580 ctx
.urbs
[i
]->transfer_flags
|= URB_ZERO_PACKET
;
1584 /* Submit all the URBs and then unlink URBs num - 4 and num - 2. */
1585 for (i
= 0; i
< num
; i
++) {
1586 atomic_inc(&ctx
.pending
);
1587 retval
= usb_submit_urb(ctx
.urbs
[i
], GFP_KERNEL
);
1589 dev_err(&dev
->intf
->dev
, "submit urbs[%d] fail %d\n",
1591 atomic_dec(&ctx
.pending
);
1592 ctx
.status
= retval
;
1597 usb_unlink_urb(ctx
.urbs
[num
- 4]);
1598 usb_unlink_urb(ctx
.urbs
[num
- 2]);
1601 usb_unlink_urb(ctx
.urbs
[i
]);
1604 if (atomic_dec_and_test(&ctx
.pending
)) /* The extra count */
1605 complete(&ctx
.complete
);
1606 wait_for_completion(&ctx
.complete
);
1607 retval
= ctx
.status
;
1610 for (i
= 0; i
< num
; i
++)
1611 usb_free_urb(ctx
.urbs
[i
]);
1614 usb_free_coherent(udev
, size
, buf
, buf_dma
);
1618 /*-------------------------------------------------------------------------*/
1620 static int verify_not_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1625 /* shouldn't look or act halted */
1626 retval
= usb_get_std_status(urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1628 ERROR(tdev
, "ep %02x couldn't get no-halt status, %d\n",
1633 ERROR(tdev
, "ep %02x bogus status: %04x != 0\n", ep
, status
);
1636 retval
= simple_io(tdev
, urb
, 1, 0, 0, __func__
);
1642 static int verify_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1647 /* should look and act halted */
1648 retval
= usb_get_std_status(urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1650 ERROR(tdev
, "ep %02x couldn't get halt status, %d\n",
1655 ERROR(tdev
, "ep %02x bogus status: %04x != 1\n", ep
, status
);
1658 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, __func__
);
1659 if (retval
!= -EPIPE
)
1661 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, "verify_still_halted");
1662 if (retval
!= -EPIPE
)
1667 static int test_halt(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1671 /* shouldn't look or act halted now */
1672 retval
= verify_not_halted(tdev
, ep
, urb
);
1676 /* set halt (protocol test only), verify it worked */
1677 retval
= usb_control_msg(urb
->dev
, usb_sndctrlpipe(urb
->dev
, 0),
1678 USB_REQ_SET_FEATURE
, USB_RECIP_ENDPOINT
,
1679 USB_ENDPOINT_HALT
, ep
,
1680 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1682 ERROR(tdev
, "ep %02x couldn't set halt, %d\n", ep
, retval
);
1685 retval
= verify_halted(tdev
, ep
, urb
);
1689 /* clear halt anyways, else further tests will fail */
1690 ret
= usb_clear_halt(urb
->dev
, urb
->pipe
);
1692 ERROR(tdev
, "ep %02x couldn't clear halt, %d\n",
1698 /* clear halt (tests API + protocol), verify it worked */
1699 retval
= usb_clear_halt(urb
->dev
, urb
->pipe
);
1701 ERROR(tdev
, "ep %02x couldn't clear halt, %d\n", ep
, retval
);
1704 retval
= verify_not_halted(tdev
, ep
, urb
);
1708 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1713 static int halt_simple(struct usbtest_dev
*dev
)
1718 struct usb_device
*udev
= testdev_to_usbdev(dev
);
1720 if (udev
->speed
== USB_SPEED_SUPER
)
1721 urb
= simple_alloc_urb(udev
, 0, 1024, 0);
1723 urb
= simple_alloc_urb(udev
, 0, 512, 0);
1728 ep
= usb_pipeendpoint(dev
->in_pipe
) | USB_DIR_IN
;
1729 urb
->pipe
= dev
->in_pipe
;
1730 retval
= test_halt(dev
, ep
, urb
);
1735 if (dev
->out_pipe
) {
1736 ep
= usb_pipeendpoint(dev
->out_pipe
);
1737 urb
->pipe
= dev
->out_pipe
;
1738 retval
= test_halt(dev
, ep
, urb
);
1741 simple_free_urb(urb
);
1745 /*-------------------------------------------------------------------------*/
1747 /* Control OUT tests use the vendor control requests from Intel's
1748 * USB 2.0 compliance test device: write a buffer, read it back.
1750 * Intel's spec only _requires_ that it work for one packet, which
1751 * is pretty weak. Some HCDs place limits here; most devices will
1752 * need to be able to handle more than one OUT data packet. We'll
1753 * try whatever we're told to try.
1755 static int ctrl_out(struct usbtest_dev
*dev
,
1756 unsigned count
, unsigned length
, unsigned vary
, unsigned offset
)
1762 struct usb_device
*udev
;
1764 if (length
< 1 || length
> 0xffff || vary
>= length
)
1767 buf
= kmalloc(length
+ offset
, GFP_KERNEL
);
1772 udev
= testdev_to_usbdev(dev
);
1776 /* NOTE: hardware might well act differently if we pushed it
1777 * with lots back-to-back queued requests.
1779 for (i
= 0; i
< count
; i
++) {
1780 /* write patterned data */
1781 for (j
= 0; j
< len
; j
++)
1782 buf
[j
] = (u8
)(i
+ j
);
1783 retval
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1784 0x5b, USB_DIR_OUT
|USB_TYPE_VENDOR
,
1785 0, 0, buf
, len
, USB_CTRL_SET_TIMEOUT
);
1786 if (retval
!= len
) {
1789 ERROR(dev
, "ctrl_out, wlen %d (expected %d)\n",
1796 /* read it back -- assuming nothing intervened!! */
1797 retval
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
1798 0x5c, USB_DIR_IN
|USB_TYPE_VENDOR
,
1799 0, 0, buf
, len
, USB_CTRL_GET_TIMEOUT
);
1800 if (retval
!= len
) {
1803 ERROR(dev
, "ctrl_out, rlen %d (expected %d)\n",
1810 /* fail if we can't verify */
1811 for (j
= 0; j
< len
; j
++) {
1812 if (buf
[j
] != (u8
)(i
+ j
)) {
1813 ERROR(dev
, "ctrl_out, byte %d is %d not %d\n",
1814 j
, buf
[j
], (u8
)(i
+ j
));
1826 /* [real world] the "zero bytes IN" case isn't really used.
1827 * hardware can easily trip up in this weird case, since its
1828 * status stage is IN, not OUT like other ep0in transfers.
1831 len
= realworld
? 1 : 0;
1835 ERROR(dev
, "ctrl_out %s failed, code %d, count %d\n",
1838 kfree(buf
- offset
);
1842 /*-------------------------------------------------------------------------*/
1844 /* ISO/BULK tests ... mimics common usage
1845 * - buffer length is split into N packets (mostly maxpacket sized)
1846 * - multi-buffers according to sglen
1849 struct transfer_context
{
1853 struct completion done
;
1855 unsigned long errors
;
1856 unsigned long packet_count
;
1857 struct usbtest_dev
*dev
;
1861 static void complicated_callback(struct urb
*urb
)
1863 struct transfer_context
*ctx
= urb
->context
;
1865 spin_lock(&ctx
->lock
);
1868 ctx
->packet_count
+= urb
->number_of_packets
;
1869 if (urb
->error_count
> 0)
1870 ctx
->errors
+= urb
->error_count
;
1871 else if (urb
->status
!= 0)
1872 ctx
->errors
+= (ctx
->is_iso
? urb
->number_of_packets
: 1);
1873 else if (urb
->actual_length
!= urb
->transfer_buffer_length
)
1875 else if (check_guard_bytes(ctx
->dev
, urb
) != 0)
1878 if (urb
->status
== 0 && ctx
->count
> (ctx
->pending
- 1)
1879 && !ctx
->submit_error
) {
1880 int status
= usb_submit_urb(urb
, GFP_ATOMIC
);
1885 dev_err(&ctx
->dev
->intf
->dev
,
1886 "resubmit err %d\n",
1889 case -ENODEV
: /* disconnected */
1890 case -ESHUTDOWN
: /* endpoint disabled */
1891 ctx
->submit_error
= 1;
1897 if (ctx
->pending
== 0) {
1899 dev_err(&ctx
->dev
->intf
->dev
,
1900 "during the test, %lu errors out of %lu\n",
1901 ctx
->errors
, ctx
->packet_count
);
1902 complete(&ctx
->done
);
1905 spin_unlock(&ctx
->lock
);
1908 static struct urb
*iso_alloc_urb(
1909 struct usb_device
*udev
,
1911 struct usb_endpoint_descriptor
*desc
,
1917 unsigned i
, maxp
, packets
;
1919 if (bytes
< 0 || !desc
)
1921 maxp
= usb_endpoint_maxp(desc
);
1922 maxp
*= usb_endpoint_maxp_mult(desc
);
1923 packets
= DIV_ROUND_UP(bytes
, maxp
);
1925 urb
= usb_alloc_urb(packets
, GFP_KERNEL
);
1931 urb
->number_of_packets
= packets
;
1932 urb
->transfer_buffer_length
= bytes
;
1933 urb
->transfer_buffer
= usb_alloc_coherent(udev
, bytes
+ offset
,
1935 &urb
->transfer_dma
);
1936 if (!urb
->transfer_buffer
) {
1941 memset(urb
->transfer_buffer
, GUARD_BYTE
, offset
);
1942 urb
->transfer_buffer
+= offset
;
1943 urb
->transfer_dma
+= offset
;
1945 /* For inbound transfers use guard byte so that test fails if
1946 data not correctly copied */
1947 memset(urb
->transfer_buffer
,
1948 usb_pipein(urb
->pipe
) ? GUARD_BYTE
: 0,
1951 for (i
= 0; i
< packets
; i
++) {
1952 /* here, only the last packet will be short */
1953 urb
->iso_frame_desc
[i
].length
= min((unsigned) bytes
, maxp
);
1954 bytes
-= urb
->iso_frame_desc
[i
].length
;
1956 urb
->iso_frame_desc
[i
].offset
= maxp
* i
;
1959 urb
->complete
= complicated_callback
;
1960 /* urb->context = SET BY CALLER */
1961 urb
->interval
= 1 << (desc
->bInterval
- 1);
1962 urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
1967 test_queue(struct usbtest_dev
*dev
, struct usbtest_param_32
*param
,
1968 int pipe
, struct usb_endpoint_descriptor
*desc
, unsigned offset
)
1970 struct transfer_context context
;
1971 struct usb_device
*udev
;
1973 unsigned long packets
= 0;
1975 struct urb
*urbs
[param
->sglen
];
1977 if (!param
->sglen
|| param
->iterations
> UINT_MAX
/ param
->sglen
)
1980 memset(&context
, 0, sizeof(context
));
1981 context
.count
= param
->iterations
* param
->sglen
;
1983 context
.is_iso
= !!desc
;
1984 init_completion(&context
.done
);
1985 spin_lock_init(&context
.lock
);
1987 udev
= testdev_to_usbdev(dev
);
1989 for (i
= 0; i
< param
->sglen
; i
++) {
1991 urbs
[i
] = iso_alloc_urb(udev
, pipe
, desc
,
1992 param
->length
, offset
);
1994 urbs
[i
] = complicated_alloc_urb(udev
, pipe
,
2001 packets
+= urbs
[i
]->number_of_packets
;
2002 urbs
[i
]->context
= &context
;
2004 packets
*= param
->iterations
;
2006 if (context
.is_iso
) {
2007 dev_info(&dev
->intf
->dev
,
2008 "iso period %d %sframes, wMaxPacket %d, transactions: %d\n",
2009 1 << (desc
->bInterval
- 1),
2010 (udev
->speed
== USB_SPEED_HIGH
) ? "micro" : "",
2011 usb_endpoint_maxp(desc
),
2012 usb_endpoint_maxp_mult(desc
));
2014 dev_info(&dev
->intf
->dev
,
2015 "total %lu msec (%lu packets)\n",
2016 (packets
* (1 << (desc
->bInterval
- 1)))
2017 / ((udev
->speed
== USB_SPEED_HIGH
) ? 8 : 1),
2021 spin_lock_irq(&context
.lock
);
2022 for (i
= 0; i
< param
->sglen
; i
++) {
2024 status
= usb_submit_urb(urbs
[i
], GFP_ATOMIC
);
2026 ERROR(dev
, "submit iso[%d], error %d\n", i
, status
);
2028 spin_unlock_irq(&context
.lock
);
2032 simple_free_urb(urbs
[i
]);
2035 context
.submit_error
= 1;
2039 spin_unlock_irq(&context
.lock
);
2041 wait_for_completion(&context
.done
);
2043 for (i
= 0; i
< param
->sglen
; i
++) {
2045 simple_free_urb(urbs
[i
]);
2048 * Isochronous transfers are expected to fail sometimes. As an
2049 * arbitrary limit, we will report an error if any submissions
2050 * fail or if the transfer failure rate is > 10%.
2054 else if (context
.submit_error
)
2056 else if (context
.errors
>
2057 (context
.is_iso
? context
.packet_count
/ 10 : 0))
2062 for (i
= 0; i
< param
->sglen
; i
++) {
2064 simple_free_urb(urbs
[i
]);
2069 static int test_unaligned_bulk(
2070 struct usbtest_dev
*tdev
,
2074 unsigned transfer_flags
,
2078 struct urb
*urb
= usbtest_alloc_urb(testdev_to_usbdev(tdev
),
2079 pipe
, length
, transfer_flags
, 1, 0, simple_callback
);
2084 retval
= simple_io(tdev
, urb
, iterations
, 0, 0, label
);
2085 simple_free_urb(urb
);
2091 usbtest_do_ioctl(struct usb_interface
*intf
, struct usbtest_param_32
*param
)
2093 struct usbtest_dev
*dev
= usb_get_intfdata(intf
);
2094 struct usb_device
*udev
= testdev_to_usbdev(dev
);
2096 struct scatterlist
*sg
;
2097 struct usb_sg_request req
;
2099 int retval
= -EOPNOTSUPP
;
2101 if (param
->iterations
<= 0)
2103 if (param
->sglen
> MAX_SGLEN
)
2106 * Just a bunch of test cases that every HCD is expected to handle.
2108 * Some may need specific firmware, though it'd be good to have
2109 * one firmware image to handle all the test cases.
2111 * FIXME add more tests! cancel requests, verify the data, control
2112 * queueing, concurrent read+write threads, and so on.
2114 switch (param
->test_num
) {
2117 dev_info(&intf
->dev
, "TEST 0: NOP\n");
2121 /* Simple non-queued bulk I/O tests */
2123 if (dev
->out_pipe
== 0)
2125 dev_info(&intf
->dev
,
2126 "TEST 1: write %d bytes %u times\n",
2127 param
->length
, param
->iterations
);
2128 urb
= simple_alloc_urb(udev
, dev
->out_pipe
, param
->length
, 0);
2133 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2134 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test1");
2135 simple_free_urb(urb
);
2138 if (dev
->in_pipe
== 0)
2140 dev_info(&intf
->dev
,
2141 "TEST 2: read %d bytes %u times\n",
2142 param
->length
, param
->iterations
);
2143 urb
= simple_alloc_urb(udev
, dev
->in_pipe
, param
->length
, 0);
2148 /* FIRMWARE: bulk source (maybe generates short writes) */
2149 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test2");
2150 simple_free_urb(urb
);
2153 if (dev
->out_pipe
== 0 || param
->vary
== 0)
2155 dev_info(&intf
->dev
,
2156 "TEST 3: write/%d 0..%d bytes %u times\n",
2157 param
->vary
, param
->length
, param
->iterations
);
2158 urb
= simple_alloc_urb(udev
, dev
->out_pipe
, param
->length
, 0);
2163 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2164 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
2166 simple_free_urb(urb
);
2169 if (dev
->in_pipe
== 0 || param
->vary
== 0)
2171 dev_info(&intf
->dev
,
2172 "TEST 4: read/%d 0..%d bytes %u times\n",
2173 param
->vary
, param
->length
, param
->iterations
);
2174 urb
= simple_alloc_urb(udev
, dev
->in_pipe
, param
->length
, 0);
2179 /* FIRMWARE: bulk source (maybe generates short writes) */
2180 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
2182 simple_free_urb(urb
);
2185 /* Queued bulk I/O tests */
2187 if (dev
->out_pipe
== 0 || param
->sglen
== 0)
2189 dev_info(&intf
->dev
,
2190 "TEST 5: write %d sglists %d entries of %d bytes\n",
2192 param
->sglen
, param
->length
);
2193 sg
= alloc_sglist(param
->sglen
, param
->length
,
2194 0, dev
, dev
->out_pipe
);
2199 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2200 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
2201 &req
, sg
, param
->sglen
);
2202 free_sglist(sg
, param
->sglen
);
2206 if (dev
->in_pipe
== 0 || param
->sglen
== 0)
2208 dev_info(&intf
->dev
,
2209 "TEST 6: read %d sglists %d entries of %d bytes\n",
2211 param
->sglen
, param
->length
);
2212 sg
= alloc_sglist(param
->sglen
, param
->length
,
2213 0, dev
, dev
->in_pipe
);
2218 /* FIRMWARE: bulk source (maybe generates short writes) */
2219 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
2220 &req
, sg
, param
->sglen
);
2221 free_sglist(sg
, param
->sglen
);
2224 if (dev
->out_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
2226 dev_info(&intf
->dev
,
2227 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
2228 param
->vary
, param
->iterations
,
2229 param
->sglen
, param
->length
);
2230 sg
= alloc_sglist(param
->sglen
, param
->length
,
2231 param
->vary
, dev
, dev
->out_pipe
);
2236 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2237 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
2238 &req
, sg
, param
->sglen
);
2239 free_sglist(sg
, param
->sglen
);
2242 if (dev
->in_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
2244 dev_info(&intf
->dev
,
2245 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
2246 param
->vary
, param
->iterations
,
2247 param
->sglen
, param
->length
);
2248 sg
= alloc_sglist(param
->sglen
, param
->length
,
2249 param
->vary
, dev
, dev
->in_pipe
);
2254 /* FIRMWARE: bulk source (maybe generates short writes) */
2255 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
2256 &req
, sg
, param
->sglen
);
2257 free_sglist(sg
, param
->sglen
);
2260 /* non-queued sanity tests for control (chapter 9 subset) */
2263 dev_info(&intf
->dev
,
2264 "TEST 9: ch9 (subset) control tests, %d times\n",
2266 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
2267 retval
= ch9_postconfig(dev
);
2269 dev_err(&intf
->dev
, "ch9 subset failed, "
2270 "iterations left %d\n", i
);
2273 /* queued control messaging */
2276 dev_info(&intf
->dev
,
2277 "TEST 10: queue %d control calls, %d times\n",
2280 retval
= test_ctrl_queue(dev
, param
);
2283 /* simple non-queued unlinks (ring with one urb) */
2285 if (dev
->in_pipe
== 0 || !param
->length
)
2288 dev_info(&intf
->dev
, "TEST 11: unlink %d reads of %d\n",
2289 param
->iterations
, param
->length
);
2290 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
2291 retval
= unlink_simple(dev
, dev
->in_pipe
,
2294 dev_err(&intf
->dev
, "unlink reads failed %d, "
2295 "iterations left %d\n", retval
, i
);
2298 if (dev
->out_pipe
== 0 || !param
->length
)
2301 dev_info(&intf
->dev
, "TEST 12: unlink %d writes of %d\n",
2302 param
->iterations
, param
->length
);
2303 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
2304 retval
= unlink_simple(dev
, dev
->out_pipe
,
2307 dev_err(&intf
->dev
, "unlink writes failed %d, "
2308 "iterations left %d\n", retval
, i
);
2313 if (dev
->out_pipe
== 0 && dev
->in_pipe
== 0)
2316 dev_info(&intf
->dev
, "TEST 13: set/clear %d halts\n",
2318 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
2319 retval
= halt_simple(dev
);
2322 ERROR(dev
, "halts failed, iterations left %d\n", i
);
2325 /* control write tests */
2327 if (!dev
->info
->ctrl_out
)
2329 dev_info(&intf
->dev
, "TEST 14: %d ep0out, %d..%d vary %d\n",
2331 realworld
? 1 : 0, param
->length
,
2333 retval
= ctrl_out(dev
, param
->iterations
,
2334 param
->length
, param
->vary
, 0);
2337 /* iso write tests */
2339 if (dev
->out_iso_pipe
== 0 || param
->sglen
== 0)
2341 dev_info(&intf
->dev
,
2342 "TEST 15: write %d iso, %d entries of %d bytes\n",
2344 param
->sglen
, param
->length
);
2345 /* FIRMWARE: iso sink */
2346 retval
= test_queue(dev
, param
,
2347 dev
->out_iso_pipe
, dev
->iso_out
, 0);
2350 /* iso read tests */
2352 if (dev
->in_iso_pipe
== 0 || param
->sglen
== 0)
2354 dev_info(&intf
->dev
,
2355 "TEST 16: read %d iso, %d entries of %d bytes\n",
2357 param
->sglen
, param
->length
);
2358 /* FIRMWARE: iso source */
2359 retval
= test_queue(dev
, param
,
2360 dev
->in_iso_pipe
, dev
->iso_in
, 0);
2363 /* FIXME scatterlist cancel (needs helper thread) */
2365 /* Tests for bulk I/O using DMA mapping by core and odd address */
2367 if (dev
->out_pipe
== 0)
2369 dev_info(&intf
->dev
,
2370 "TEST 17: write odd addr %d bytes %u times core map\n",
2371 param
->length
, param
->iterations
);
2373 retval
= test_unaligned_bulk(
2375 param
->length
, param
->iterations
,
2380 if (dev
->in_pipe
== 0)
2382 dev_info(&intf
->dev
,
2383 "TEST 18: read odd addr %d bytes %u times core map\n",
2384 param
->length
, param
->iterations
);
2386 retval
= test_unaligned_bulk(
2388 param
->length
, param
->iterations
,
2392 /* Tests for bulk I/O using premapped coherent buffer and odd address */
2394 if (dev
->out_pipe
== 0)
2396 dev_info(&intf
->dev
,
2397 "TEST 19: write odd addr %d bytes %u times premapped\n",
2398 param
->length
, param
->iterations
);
2400 retval
= test_unaligned_bulk(
2402 param
->length
, param
->iterations
,
2403 URB_NO_TRANSFER_DMA_MAP
, "test19");
2407 if (dev
->in_pipe
== 0)
2409 dev_info(&intf
->dev
,
2410 "TEST 20: read odd addr %d bytes %u times premapped\n",
2411 param
->length
, param
->iterations
);
2413 retval
= test_unaligned_bulk(
2415 param
->length
, param
->iterations
,
2416 URB_NO_TRANSFER_DMA_MAP
, "test20");
2419 /* control write tests with unaligned buffer */
2421 if (!dev
->info
->ctrl_out
)
2423 dev_info(&intf
->dev
,
2424 "TEST 21: %d ep0out odd addr, %d..%d vary %d\n",
2426 realworld
? 1 : 0, param
->length
,
2428 retval
= ctrl_out(dev
, param
->iterations
,
2429 param
->length
, param
->vary
, 1);
2432 /* unaligned iso tests */
2434 if (dev
->out_iso_pipe
== 0 || param
->sglen
== 0)
2436 dev_info(&intf
->dev
,
2437 "TEST 22: write %d iso odd, %d entries of %d bytes\n",
2439 param
->sglen
, param
->length
);
2440 retval
= test_queue(dev
, param
,
2441 dev
->out_iso_pipe
, dev
->iso_out
, 1);
2445 if (dev
->in_iso_pipe
== 0 || param
->sglen
== 0)
2447 dev_info(&intf
->dev
,
2448 "TEST 23: read %d iso odd, %d entries of %d bytes\n",
2450 param
->sglen
, param
->length
);
2451 retval
= test_queue(dev
, param
,
2452 dev
->in_iso_pipe
, dev
->iso_in
, 1);
2455 /* unlink URBs from a bulk-OUT queue */
2457 if (dev
->out_pipe
== 0 || !param
->length
|| param
->sglen
< 4)
2460 dev_info(&intf
->dev
, "TEST 24: unlink from %d queues of "
2461 "%d %d-byte writes\n",
2462 param
->iterations
, param
->sglen
, param
->length
);
2463 for (i
= param
->iterations
; retval
== 0 && i
> 0; --i
) {
2464 retval
= unlink_queued(dev
, dev
->out_pipe
,
2465 param
->sglen
, param
->length
);
2468 "unlink queued writes failed %d, "
2469 "iterations left %d\n", retval
, i
);
2475 /* Simple non-queued interrupt I/O tests */
2477 if (dev
->out_int_pipe
== 0)
2479 dev_info(&intf
->dev
,
2480 "TEST 25: write %d bytes %u times\n",
2481 param
->length
, param
->iterations
);
2482 urb
= simple_alloc_urb(udev
, dev
->out_int_pipe
, param
->length
,
2483 dev
->int_out
->bInterval
);
2488 /* FIRMWARE: interrupt sink (maybe accepts short writes) */
2489 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test25");
2490 simple_free_urb(urb
);
2493 if (dev
->in_int_pipe
== 0)
2495 dev_info(&intf
->dev
,
2496 "TEST 26: read %d bytes %u times\n",
2497 param
->length
, param
->iterations
);
2498 urb
= simple_alloc_urb(udev
, dev
->in_int_pipe
, param
->length
,
2499 dev
->int_in
->bInterval
);
2504 /* FIRMWARE: interrupt source (maybe generates short writes) */
2505 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test26");
2506 simple_free_urb(urb
);
2509 /* We do performance test, so ignore data compare */
2510 if (dev
->out_pipe
== 0 || param
->sglen
== 0 || pattern
!= 0)
2512 dev_info(&intf
->dev
,
2513 "TEST 27: bulk write %dMbytes\n", (param
->iterations
*
2514 param
->sglen
* param
->length
) / (1024 * 1024));
2515 retval
= test_queue(dev
, param
,
2516 dev
->out_pipe
, NULL
, 0);
2519 if (dev
->in_pipe
== 0 || param
->sglen
== 0 || pattern
!= 0)
2521 dev_info(&intf
->dev
,
2522 "TEST 28: bulk read %dMbytes\n", (param
->iterations
*
2523 param
->sglen
* param
->length
) / (1024 * 1024));
2524 retval
= test_queue(dev
, param
,
2525 dev
->in_pipe
, NULL
, 0);
2531 /*-------------------------------------------------------------------------*/
2533 /* We only have this one interface to user space, through usbfs.
2534 * User mode code can scan usbfs to find N different devices (maybe on
2535 * different busses) to use when testing, and allocate one thread per
2536 * test. So discovery is simplified, and we have no device naming issues.
2538 * Don't use these only as stress/load tests. Use them along with with
2539 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
2540 * video capture, and so on. Run different tests at different times, in
2541 * different sequences. Nothing here should interact with other devices,
2542 * except indirectly by consuming USB bandwidth and CPU resources for test
2543 * threads and request completion. But the only way to know that for sure
2544 * is to test when HC queues are in use by many devices.
2546 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
2547 * it locks out usbcore in certain code paths. Notably, if you disconnect
2548 * the device-under-test, hub_wq will wait block forever waiting for the
2549 * ioctl to complete ... so that usb_disconnect() can abort the pending
2550 * urbs and then call usbtest_disconnect(). To abort a test, you're best
2551 * off just killing the userspace task and waiting for it to exit.
2555 usbtest_ioctl(struct usb_interface
*intf
, unsigned int code
, void *buf
)
2558 struct usbtest_dev
*dev
= usb_get_intfdata(intf
);
2559 struct usbtest_param_64
*param_64
= buf
;
2560 struct usbtest_param_32 temp
;
2561 struct usbtest_param_32
*param_32
= buf
;
2562 struct timespec64 start
;
2563 struct timespec64 end
;
2564 struct timespec64 duration
;
2565 int retval
= -EOPNOTSUPP
;
2567 /* FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is. */
2569 pattern
= mod_pattern
;
2571 if (mutex_lock_interruptible(&dev
->lock
))
2572 return -ERESTARTSYS
;
2574 /* FIXME: What if a system sleep starts while a test is running? */
2576 /* some devices, like ez-usb default devices, need a non-default
2577 * altsetting to have any active endpoints. some tests change
2578 * altsettings; force a default so most tests don't need to check.
2580 if (dev
->info
->alt
>= 0) {
2581 if (intf
->altsetting
->desc
.bInterfaceNumber
) {
2585 retval
= set_altsetting(dev
, dev
->info
->alt
);
2588 "set altsetting to %d failed, %d\n",
2589 dev
->info
->alt
, retval
);
2595 case USBTEST_REQUEST_64
:
2596 temp
.test_num
= param_64
->test_num
;
2597 temp
.iterations
= param_64
->iterations
;
2598 temp
.length
= param_64
->length
;
2599 temp
.sglen
= param_64
->sglen
;
2600 temp
.vary
= param_64
->vary
;
2604 case USBTEST_REQUEST_32
:
2608 retval
= -EOPNOTSUPP
;
2612 ktime_get_ts64(&start
);
2614 retval
= usbtest_do_ioctl(intf
, param_32
);
2618 ktime_get_ts64(&end
);
2620 duration
= timespec64_sub(end
, start
);
2622 temp
.duration_sec
= duration
.tv_sec
;
2623 temp
.duration_usec
= duration
.tv_nsec
/NSEC_PER_USEC
;
2626 case USBTEST_REQUEST_32
:
2627 param_32
->duration_sec
= temp
.duration_sec
;
2628 param_32
->duration_usec
= temp
.duration_usec
;
2631 case USBTEST_REQUEST_64
:
2632 param_64
->duration_sec
= temp
.duration_sec
;
2633 param_64
->duration_usec
= temp
.duration_usec
;
2638 mutex_unlock(&dev
->lock
);
2642 /*-------------------------------------------------------------------------*/
2644 static unsigned force_interrupt
;
2645 module_param(force_interrupt
, uint
, 0);
2646 MODULE_PARM_DESC(force_interrupt
, "0 = test default; else interrupt");
2649 static unsigned short vendor
;
2650 module_param(vendor
, ushort
, 0);
2651 MODULE_PARM_DESC(vendor
, "vendor code (from usb-if)");
2653 static unsigned short product
;
2654 module_param(product
, ushort
, 0);
2655 MODULE_PARM_DESC(product
, "product code (from vendor)");
2659 usbtest_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
2661 struct usb_device
*udev
;
2662 struct usbtest_dev
*dev
;
2663 struct usbtest_info
*info
;
2664 char *rtest
, *wtest
;
2665 char *irtest
, *iwtest
;
2666 char *intrtest
, *intwtest
;
2668 udev
= interface_to_usbdev(intf
);
2671 /* specify devices by module parameters? */
2672 if (id
->match_flags
== 0) {
2673 /* vendor match required, product match optional */
2674 if (!vendor
|| le16_to_cpu(udev
->descriptor
.idVendor
) != (u16
)vendor
)
2676 if (product
&& le16_to_cpu(udev
->descriptor
.idProduct
) != (u16
)product
)
2678 dev_info(&intf
->dev
, "matched module params, "
2679 "vend=0x%04x prod=0x%04x\n",
2680 le16_to_cpu(udev
->descriptor
.idVendor
),
2681 le16_to_cpu(udev
->descriptor
.idProduct
));
2685 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
2688 info
= (struct usbtest_info
*) id
->driver_info
;
2690 mutex_init(&dev
->lock
);
2694 /* cacheline-aligned scratch for i/o */
2695 dev
->buf
= kmalloc(TBUF_SIZE
, GFP_KERNEL
);
2696 if (dev
->buf
== NULL
) {
2701 /* NOTE this doesn't yet test the handful of difference that are
2702 * visible with high speed interrupts: bigger maxpacket (1K) and
2703 * "high bandwidth" modes (up to 3 packets/uframe).
2706 irtest
= iwtest
= "";
2707 intrtest
= intwtest
= "";
2708 if (force_interrupt
|| udev
->speed
== USB_SPEED_LOW
) {
2710 dev
->in_pipe
= usb_rcvintpipe(udev
, info
->ep_in
);
2714 dev
->out_pipe
= usb_sndintpipe(udev
, info
->ep_out
);
2715 wtest
= " intr-out";
2718 if (override_alt
>= 0 || info
->autoconf
) {
2721 status
= get_endpoints(dev
, intf
);
2723 WARNING(dev
, "couldn't get endpoints, %d\n",
2729 /* may find bulk or ISO pipes */
2732 dev
->in_pipe
= usb_rcvbulkpipe(udev
,
2735 dev
->out_pipe
= usb_sndbulkpipe(udev
,
2741 wtest
= " bulk-out";
2742 if (dev
->in_iso_pipe
)
2744 if (dev
->out_iso_pipe
)
2745 iwtest
= " iso-out";
2746 if (dev
->in_int_pipe
)
2747 intrtest
= " int-in";
2748 if (dev
->out_int_pipe
)
2749 intwtest
= " int-out";
2752 usb_set_intfdata(intf
, dev
);
2753 dev_info(&intf
->dev
, "%s\n", info
->name
);
2754 dev_info(&intf
->dev
, "%s {control%s%s%s%s%s%s%s} tests%s\n",
2755 usb_speed_string(udev
->speed
),
2756 info
->ctrl_out
? " in/out" : "",
2760 info
->alt
>= 0 ? " (+alt)" : "");
2764 static int usbtest_suspend(struct usb_interface
*intf
, pm_message_t message
)
2769 static int usbtest_resume(struct usb_interface
*intf
)
2775 static void usbtest_disconnect(struct usb_interface
*intf
)
2777 struct usbtest_dev
*dev
= usb_get_intfdata(intf
);
2779 usb_set_intfdata(intf
, NULL
);
2780 dev_dbg(&intf
->dev
, "disconnect\n");
2784 /* Basic testing only needs a device that can source or sink bulk traffic.
2785 * Any device can test control transfers (default with GENERIC binding).
2787 * Several entries work with the default EP0 implementation that's built
2788 * into EZ-USB chips. There's a default vendor ID which can be overridden
2789 * by (very) small config EEPROMS, but otherwise all these devices act
2790 * identically until firmware is loaded: only EP0 works. It turns out
2791 * to be easy to make other endpoints work, without modifying that EP0
2792 * behavior. For now, we expect that kind of firmware.
2795 /* an21xx or fx versions of ez-usb */
2796 static struct usbtest_info ez1_info
= {
2797 .name
= "EZ-USB device",
2803 /* fx2 version of ez-usb */
2804 static struct usbtest_info ez2_info
= {
2805 .name
= "FX2 device",
2811 /* ezusb family device with dedicated usb test firmware,
2813 static struct usbtest_info fw_info
= {
2814 .name
= "usb test device",
2818 .autoconf
= 1, /* iso and ctrl_out need autoconf */
2820 .iso
= 1, /* iso_ep's are #8 in/out */
2823 /* peripheral running Linux and 'zero.c' test firmware, or
2824 * its user-mode cousin. different versions of this use
2825 * different hardware with the same vendor/product codes.
2826 * host side MUST rely on the endpoint descriptors.
2828 static struct usbtest_info gz_info
= {
2829 .name
= "Linux gadget zero",
2837 static struct usbtest_info um_info
= {
2838 .name
= "Linux user mode test driver",
2843 static struct usbtest_info um2_info
= {
2844 .name
= "Linux user mode ISO test driver",
2851 /* this is a nice source of high speed bulk data;
2852 * uses an FX2, with firmware provided in the device
2854 static struct usbtest_info ibot2_info
= {
2855 .name
= "iBOT2 webcam",
2862 /* we can use any device to test control traffic */
2863 static struct usbtest_info generic_info
= {
2864 .name
= "Generic USB device",
2870 static const struct usb_device_id id_table
[] = {
2872 /*-------------------------------------------------------------*/
2874 /* EZ-USB devices which download firmware to replace (or in our
2875 * case augment) the default device implementation.
2878 /* generic EZ-USB FX controller */
2879 { USB_DEVICE(0x0547, 0x2235),
2880 .driver_info
= (unsigned long) &ez1_info
,
2883 /* CY3671 development board with EZ-USB FX */
2884 { USB_DEVICE(0x0547, 0x0080),
2885 .driver_info
= (unsigned long) &ez1_info
,
2888 /* generic EZ-USB FX2 controller (or development board) */
2889 { USB_DEVICE(0x04b4, 0x8613),
2890 .driver_info
= (unsigned long) &ez2_info
,
2893 /* re-enumerated usb test device firmware */
2894 { USB_DEVICE(0xfff0, 0xfff0),
2895 .driver_info
= (unsigned long) &fw_info
,
2898 /* "Gadget Zero" firmware runs under Linux */
2899 { USB_DEVICE(0x0525, 0xa4a0),
2900 .driver_info
= (unsigned long) &gz_info
,
2903 /* so does a user-mode variant */
2904 { USB_DEVICE(0x0525, 0xa4a4),
2905 .driver_info
= (unsigned long) &um_info
,
2908 /* ... and a user-mode variant that talks iso */
2909 { USB_DEVICE(0x0525, 0xa4a3),
2910 .driver_info
= (unsigned long) &um2_info
,
2914 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2915 /* this does not coexist with the real Keyspan 19qi driver! */
2916 { USB_DEVICE(0x06cd, 0x010b),
2917 .driver_info
= (unsigned long) &ez1_info
,
2921 /*-------------------------------------------------------------*/
2924 /* iBOT2 makes a nice source of high speed bulk-in data */
2925 /* this does not coexist with a real iBOT2 driver! */
2926 { USB_DEVICE(0x0b62, 0x0059),
2927 .driver_info
= (unsigned long) &ibot2_info
,
2931 /*-------------------------------------------------------------*/
2934 /* module params can specify devices to use for control tests */
2935 { .driver_info
= (unsigned long) &generic_info
, },
2938 /*-------------------------------------------------------------*/
2942 MODULE_DEVICE_TABLE(usb
, id_table
);
2944 static struct usb_driver usbtest_driver
= {
2946 .id_table
= id_table
,
2947 .probe
= usbtest_probe
,
2948 .unlocked_ioctl
= usbtest_ioctl
,
2949 .disconnect
= usbtest_disconnect
,
2950 .suspend
= usbtest_suspend
,
2951 .resume
= usbtest_resume
,
2954 /*-------------------------------------------------------------------------*/
2956 static int __init
usbtest_init(void)
2960 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor
, product
);
2962 return usb_register(&usbtest_driver
);
2964 module_init(usbtest_init
);
2966 static void __exit
usbtest_exit(void)
2968 usb_deregister(&usbtest_driver
);
2970 module_exit(usbtest_exit
);
2972 MODULE_DESCRIPTION("USB Core/HCD Testing Driver");
2973 MODULE_LICENSE("GPL");