1 #include <linux/kernel.h>
2 #include <linux/errno.h>
3 #include <linux/init.h>
4 #include <linux/slab.h>
6 #include <linux/module.h>
7 #include <linux/moduleparam.h>
8 #include <linux/scatterlist.h>
9 #include <linux/mutex.h>
11 #include <linux/usb.h>
14 /*-------------------------------------------------------------------------*/
16 /* FIXME make these public somewhere; usbdevfs.h? */
17 struct usbtest_param
{
19 unsigned test_num
; /* 0..(TEST_CASES-1) */
26 struct timeval duration
;
28 #define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param)
30 /*-------------------------------------------------------------------------*/
32 #define GENERIC /* let probe() bind using module params */
34 /* Some devices that can be used for testing will have "real" drivers.
35 * Entries for those need to be enabled here by hand, after disabling
38 //#define IBOT2 /* grab iBOT2 webcams */
39 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
41 /*-------------------------------------------------------------------------*/
45 u8 ep_in
; /* bulk/intr source */
46 u8 ep_out
; /* bulk/intr sink */
49 unsigned iso
:1; /* try iso in/out */
53 /* this is accessed only through usbfs ioctl calls.
54 * one ioctl to issue a test ... one lock per device.
55 * tests create other threads if they need them.
56 * urbs and buffers are allocated dynamically,
57 * and data generated deterministically.
60 struct usb_interface
*intf
;
61 struct usbtest_info
*info
;
66 struct usb_endpoint_descriptor
*iso_in
, *iso_out
;
73 static struct usb_device
*testdev_to_usbdev(struct usbtest_dev
*test
)
75 return interface_to_usbdev(test
->intf
);
78 /* set up all urbs so they can be used with either bulk or interrupt */
79 #define INTERRUPT_RATE 1 /* msec/transfer */
81 #define ERROR(tdev, fmt, args...) \
82 dev_err(&(tdev)->intf->dev , fmt , ## args)
83 #define WARNING(tdev, fmt, args...) \
84 dev_warn(&(tdev)->intf->dev , fmt , ## args)
86 /*-------------------------------------------------------------------------*/
89 get_endpoints(struct usbtest_dev
*dev
, struct usb_interface
*intf
)
92 struct usb_host_interface
*alt
;
93 struct usb_host_endpoint
*in
, *out
;
94 struct usb_host_endpoint
*iso_in
, *iso_out
;
95 struct usb_device
*udev
;
97 for (tmp
= 0; tmp
< intf
->num_altsetting
; tmp
++) {
101 iso_in
= iso_out
= NULL
;
102 alt
= intf
->altsetting
+ tmp
;
104 /* take the first altsetting with in-bulk + out-bulk;
105 * ignore other endpoints and altsetttings.
107 for (ep
= 0; ep
< alt
->desc
.bNumEndpoints
; ep
++) {
108 struct usb_host_endpoint
*e
;
110 e
= alt
->endpoint
+ ep
;
111 switch (e
->desc
.bmAttributes
) {
112 case USB_ENDPOINT_XFER_BULK
:
114 case USB_ENDPOINT_XFER_ISOC
:
121 if (usb_endpoint_dir_in(&e
->desc
)) {
130 if (usb_endpoint_dir_in(&e
->desc
)) {
138 if ((in
&& out
) || iso_in
|| iso_out
)
144 udev
= testdev_to_usbdev(dev
);
145 if (alt
->desc
.bAlternateSetting
!= 0) {
146 tmp
= usb_set_interface(udev
,
147 alt
->desc
.bInterfaceNumber
,
148 alt
->desc
.bAlternateSetting
);
154 dev
->in_pipe
= usb_rcvbulkpipe(udev
,
155 in
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
156 dev
->out_pipe
= usb_sndbulkpipe(udev
,
157 out
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
160 dev
->iso_in
= &iso_in
->desc
;
161 dev
->in_iso_pipe
= usb_rcvisocpipe(udev
,
162 iso_in
->desc
.bEndpointAddress
163 & USB_ENDPOINT_NUMBER_MASK
);
167 dev
->iso_out
= &iso_out
->desc
;
168 dev
->out_iso_pipe
= usb_sndisocpipe(udev
,
169 iso_out
->desc
.bEndpointAddress
170 & USB_ENDPOINT_NUMBER_MASK
);
175 /*-------------------------------------------------------------------------*/
177 /* Support for testing basic non-queued I/O streams.
179 * These just package urbs as requests that can be easily canceled.
180 * Each urb's data buffer is dynamically allocated; callers can fill
181 * them with non-zero test data (or test for it) when appropriate.
184 static void simple_callback(struct urb
*urb
)
186 complete(urb
->context
);
189 static struct urb
*simple_alloc_urb(
190 struct usb_device
*udev
,
197 urb
= usb_alloc_urb(0, GFP_KERNEL
);
200 usb_fill_bulk_urb(urb
, udev
, pipe
, NULL
, bytes
, simple_callback
, NULL
);
201 urb
->interval
= (udev
->speed
== USB_SPEED_HIGH
)
202 ? (INTERRUPT_RATE
<< 3)
204 urb
->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
205 if (usb_pipein(pipe
))
206 urb
->transfer_flags
|= URB_SHORT_NOT_OK
;
207 urb
->transfer_buffer
= usb_alloc_coherent(udev
, bytes
, GFP_KERNEL
,
209 if (!urb
->transfer_buffer
) {
213 memset(urb
->transfer_buffer
, 0, bytes
);
217 static unsigned pattern
;
218 static unsigned mod_pattern
;
219 module_param_named(pattern
, mod_pattern
, uint
, S_IRUGO
| S_IWUSR
);
220 MODULE_PARM_DESC(mod_pattern
, "i/o pattern (0 == zeroes)");
222 static inline void simple_fill_buf(struct urb
*urb
)
225 u8
*buf
= urb
->transfer_buffer
;
226 unsigned len
= urb
->transfer_buffer_length
;
235 for (i
= 0; i
< len
; i
++)
236 *buf
++ = (u8
) (i
% 63);
241 static inline int simple_check_buf(struct usbtest_dev
*tdev
, struct urb
*urb
)
245 u8
*buf
= urb
->transfer_buffer
;
246 unsigned len
= urb
->actual_length
;
248 for (i
= 0; i
< len
; i
++, buf
++) {
250 /* all-zeroes has no synchronization issues */
254 /* mod63 stays in sync with short-terminated transfers,
255 * or otherwise when host and gadget agree on how large
256 * each usb transfer request should be. resync is done
257 * with set_interface or set_config.
262 /* always fail unsupported patterns */
267 if (*buf
== expected
)
269 ERROR(tdev
, "buf[%d] = %d (not %d)\n", i
, *buf
, expected
);
275 static void simple_free_urb(struct urb
*urb
)
277 usb_free_coherent(urb
->dev
, urb
->transfer_buffer_length
,
278 urb
->transfer_buffer
, urb
->transfer_dma
);
282 static int simple_io(
283 struct usbtest_dev
*tdev
,
291 struct usb_device
*udev
= urb
->dev
;
292 int max
= urb
->transfer_buffer_length
;
293 struct completion completion
;
296 urb
->context
= &completion
;
297 while (retval
== 0 && iterations
-- > 0) {
298 init_completion(&completion
);
299 if (usb_pipeout(urb
->pipe
))
300 simple_fill_buf(urb
);
301 retval
= usb_submit_urb(urb
, GFP_KERNEL
);
305 /* NOTE: no timeouts; can't be broken out of by interrupt */
306 wait_for_completion(&completion
);
307 retval
= urb
->status
;
309 if (retval
== 0 && usb_pipein(urb
->pipe
))
310 retval
= simple_check_buf(tdev
, urb
);
313 int len
= urb
->transfer_buffer_length
;
318 len
= (vary
< max
) ? vary
: max
;
319 urb
->transfer_buffer_length
= len
;
322 /* FIXME if endpoint halted, clear halt (and log) */
324 urb
->transfer_buffer_length
= max
;
326 if (expected
!= retval
)
328 "%s failed, iterations left %d, status %d (not %d)\n",
329 label
, iterations
, retval
, expected
);
334 /*-------------------------------------------------------------------------*/
336 /* We use scatterlist primitives to test queued I/O.
337 * Yes, this also tests the scatterlist primitives.
340 static void free_sglist(struct scatterlist
*sg
, int nents
)
346 for (i
= 0; i
< nents
; i
++) {
347 if (!sg_page(&sg
[i
]))
349 kfree(sg_virt(&sg
[i
]));
354 static struct scatterlist
*
355 alloc_sglist(int nents
, int max
, int vary
)
357 struct scatterlist
*sg
;
361 sg
= kmalloc(nents
* sizeof *sg
, GFP_KERNEL
);
364 sg_init_table(sg
, nents
);
366 for (i
= 0; i
< nents
; i
++) {
370 buf
= kzalloc(size
, GFP_KERNEL
);
376 /* kmalloc pages are always physically contiguous! */
377 sg_set_buf(&sg
[i
], buf
, size
);
384 for (j
= 0; j
< size
; j
++)
385 *buf
++ = (u8
) (j
% 63);
393 size
= (vary
< max
) ? vary
: max
;
400 static int perform_sglist(
401 struct usbtest_dev
*tdev
,
404 struct usb_sg_request
*req
,
405 struct scatterlist
*sg
,
409 struct usb_device
*udev
= testdev_to_usbdev(tdev
);
412 while (retval
== 0 && iterations
-- > 0) {
413 retval
= usb_sg_init(req
, udev
, pipe
,
414 (udev
->speed
== USB_SPEED_HIGH
)
415 ? (INTERRUPT_RATE
<< 3)
417 sg
, nents
, 0, GFP_KERNEL
);
422 retval
= req
->status
;
424 /* FIXME check resulting data pattern */
426 /* FIXME if endpoint halted, clear halt (and log) */
429 /* FIXME for unlink or fault handling tests, don't report
430 * failure if retval is as we expected ...
433 ERROR(tdev
, "perform_sglist failed, "
434 "iterations left %d, status %d\n",
440 /*-------------------------------------------------------------------------*/
442 /* unqueued control message testing
444 * there's a nice set of device functional requirements in chapter 9 of the
445 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
446 * special test firmware.
448 * we know the device is configured (or suspended) by the time it's visible
449 * through usbfs. we can't change that, so we won't test enumeration (which
450 * worked 'well enough' to get here, this time), power management (ditto),
451 * or remote wakeup (which needs human interaction).
454 static unsigned realworld
= 1;
455 module_param(realworld
, uint
, 0);
456 MODULE_PARM_DESC(realworld
, "clear to demand stricter spec compliance");
458 static int get_altsetting(struct usbtest_dev
*dev
)
460 struct usb_interface
*iface
= dev
->intf
;
461 struct usb_device
*udev
= interface_to_usbdev(iface
);
464 retval
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
465 USB_REQ_GET_INTERFACE
, USB_DIR_IN
|USB_RECIP_INTERFACE
,
466 0, iface
->altsetting
[0].desc
.bInterfaceNumber
,
467 dev
->buf
, 1, USB_CTRL_GET_TIMEOUT
);
479 static int set_altsetting(struct usbtest_dev
*dev
, int alternate
)
481 struct usb_interface
*iface
= dev
->intf
;
482 struct usb_device
*udev
;
484 if (alternate
< 0 || alternate
>= 256)
487 udev
= interface_to_usbdev(iface
);
488 return usb_set_interface(udev
,
489 iface
->altsetting
[0].desc
.bInterfaceNumber
,
493 static int is_good_config(struct usbtest_dev
*tdev
, int len
)
495 struct usb_config_descriptor
*config
;
497 if (len
< sizeof *config
)
499 config
= (struct usb_config_descriptor
*) tdev
->buf
;
501 switch (config
->bDescriptorType
) {
503 case USB_DT_OTHER_SPEED_CONFIG
:
504 if (config
->bLength
!= 9) {
505 ERROR(tdev
, "bogus config descriptor length\n");
508 /* this bit 'must be 1' but often isn't */
509 if (!realworld
&& !(config
->bmAttributes
& 0x80)) {
510 ERROR(tdev
, "high bit of config attributes not set\n");
513 if (config
->bmAttributes
& 0x1f) { /* reserved == 0 */
514 ERROR(tdev
, "reserved config bits set\n");
522 if (le16_to_cpu(config
->wTotalLength
) == len
) /* read it all */
524 if (le16_to_cpu(config
->wTotalLength
) >= TBUF_SIZE
) /* max partial read */
526 ERROR(tdev
, "bogus config descriptor read size\n");
530 /* sanity test for standard requests working with usb_control_mesg() and some
531 * of the utility functions which use it.
533 * this doesn't test how endpoint halts behave or data toggles get set, since
534 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
535 * halt or toggle). toggle testing is impractical without support from hcds.
537 * this avoids failing devices linux would normally work with, by not testing
538 * config/altsetting operations for devices that only support their defaults.
539 * such devices rarely support those needless operations.
541 * NOTE that since this is a sanity test, it's not examining boundary cases
542 * to see if usbcore, hcd, and device all behave right. such testing would
543 * involve varied read sizes and other operation sequences.
545 static int ch9_postconfig(struct usbtest_dev
*dev
)
547 struct usb_interface
*iface
= dev
->intf
;
548 struct usb_device
*udev
= interface_to_usbdev(iface
);
551 /* [9.2.3] if there's more than one altsetting, we need to be able to
552 * set and get each one. mostly trusts the descriptors from usbcore.
554 for (i
= 0; i
< iface
->num_altsetting
; i
++) {
556 /* 9.2.3 constrains the range here */
557 alt
= iface
->altsetting
[i
].desc
.bAlternateSetting
;
558 if (alt
< 0 || alt
>= iface
->num_altsetting
) {
560 "invalid alt [%d].bAltSetting = %d\n",
564 /* [real world] get/set unimplemented if there's only one */
565 if (realworld
&& iface
->num_altsetting
== 1)
568 /* [9.4.10] set_interface */
569 retval
= set_altsetting(dev
, alt
);
571 dev_err(&iface
->dev
, "can't set_interface = %d, %d\n",
576 /* [9.4.4] get_interface always works */
577 retval
= get_altsetting(dev
);
579 dev_err(&iface
->dev
, "get alt should be %d, was %d\n",
581 return (retval
< 0) ? retval
: -EDOM
;
586 /* [real world] get_config unimplemented if there's only one */
587 if (!realworld
|| udev
->descriptor
.bNumConfigurations
!= 1) {
588 int expected
= udev
->actconfig
->desc
.bConfigurationValue
;
590 /* [9.4.2] get_configuration always works
591 * ... although some cheap devices (like one TI Hub I've got)
592 * won't return config descriptors except before set_config.
594 retval
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
595 USB_REQ_GET_CONFIGURATION
,
596 USB_DIR_IN
| USB_RECIP_DEVICE
,
597 0, 0, dev
->buf
, 1, USB_CTRL_GET_TIMEOUT
);
598 if (retval
!= 1 || dev
->buf
[0] != expected
) {
599 dev_err(&iface
->dev
, "get config --> %d %d (1 %d)\n",
600 retval
, dev
->buf
[0], expected
);
601 return (retval
< 0) ? retval
: -EDOM
;
605 /* there's always [9.4.3] a device descriptor [9.6.1] */
606 retval
= usb_get_descriptor(udev
, USB_DT_DEVICE
, 0,
607 dev
->buf
, sizeof udev
->descriptor
);
608 if (retval
!= sizeof udev
->descriptor
) {
609 dev_err(&iface
->dev
, "dev descriptor --> %d\n", retval
);
610 return (retval
< 0) ? retval
: -EDOM
;
613 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
614 for (i
= 0; i
< udev
->descriptor
.bNumConfigurations
; i
++) {
615 retval
= usb_get_descriptor(udev
, USB_DT_CONFIG
, i
,
616 dev
->buf
, TBUF_SIZE
);
617 if (!is_good_config(dev
, retval
)) {
619 "config [%d] descriptor --> %d\n",
621 return (retval
< 0) ? retval
: -EDOM
;
624 /* FIXME cross-checking udev->config[i] to make sure usbcore
625 * parsed it right (etc) would be good testing paranoia
629 /* and sometimes [9.2.6.6] speed dependent descriptors */
630 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) == 0x0200) {
631 struct usb_qualifier_descriptor
*d
= NULL
;
633 /* device qualifier [9.6.2] */
634 retval
= usb_get_descriptor(udev
,
635 USB_DT_DEVICE_QUALIFIER
, 0, dev
->buf
,
636 sizeof(struct usb_qualifier_descriptor
));
637 if (retval
== -EPIPE
) {
638 if (udev
->speed
== USB_SPEED_HIGH
) {
640 "hs dev qualifier --> %d\n",
642 return (retval
< 0) ? retval
: -EDOM
;
644 /* usb2.0 but not high-speed capable; fine */
645 } else if (retval
!= sizeof(struct usb_qualifier_descriptor
)) {
646 dev_err(&iface
->dev
, "dev qualifier --> %d\n", retval
);
647 return (retval
< 0) ? retval
: -EDOM
;
649 d
= (struct usb_qualifier_descriptor
*) dev
->buf
;
651 /* might not have [9.6.2] any other-speed configs [9.6.4] */
653 unsigned max
= d
->bNumConfigurations
;
654 for (i
= 0; i
< max
; i
++) {
655 retval
= usb_get_descriptor(udev
,
656 USB_DT_OTHER_SPEED_CONFIG
, i
,
657 dev
->buf
, TBUF_SIZE
);
658 if (!is_good_config(dev
, retval
)) {
660 "other speed config --> %d\n",
662 return (retval
< 0) ? retval
: -EDOM
;
667 /* FIXME fetch strings from at least the device descriptor */
669 /* [9.4.5] get_status always works */
670 retval
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, dev
->buf
);
672 dev_err(&iface
->dev
, "get dev status --> %d\n", retval
);
673 return (retval
< 0) ? retval
: -EDOM
;
676 /* FIXME configuration.bmAttributes says if we could try to set/clear
677 * the device's remote wakeup feature ... if we can, test that here
680 retval
= usb_get_status(udev
, USB_RECIP_INTERFACE
,
681 iface
->altsetting
[0].desc
.bInterfaceNumber
, dev
->buf
);
683 dev_err(&iface
->dev
, "get interface status --> %d\n", retval
);
684 return (retval
< 0) ? retval
: -EDOM
;
686 /* FIXME get status for each endpoint in the interface */
691 /*-------------------------------------------------------------------------*/
693 /* use ch9 requests to test whether:
694 * (a) queues work for control, keeping N subtests queued and
695 * active (auto-resubmit) for M loops through the queue.
696 * (b) protocol stalls (control-only) will autorecover.
697 * it's not like bulk/intr; no halt clearing.
698 * (c) short control reads are reported and handled.
699 * (d) queues are always processed in-order
704 struct usbtest_dev
*dev
;
705 struct completion complete
;
710 struct usbtest_param
*param
;
714 #define NUM_SUBCASES 15 /* how many test subcases here? */
717 struct usb_ctrlrequest setup
;
722 static void ctrl_complete(struct urb
*urb
)
724 struct ctrl_ctx
*ctx
= urb
->context
;
725 struct usb_ctrlrequest
*reqp
;
726 struct subcase
*subcase
;
727 int status
= urb
->status
;
729 reqp
= (struct usb_ctrlrequest
*)urb
->setup_packet
;
730 subcase
= container_of(reqp
, struct subcase
, setup
);
732 spin_lock(&ctx
->lock
);
736 /* queue must transfer and complete in fifo order, unless
737 * usb_unlink_urb() is used to unlink something not at the
738 * physical queue head (not tested).
740 if (subcase
->number
> 0) {
741 if ((subcase
->number
- ctx
->last
) != 1) {
743 "subcase %d completed out of order, last %d\n",
744 subcase
->number
, ctx
->last
);
746 ctx
->last
= subcase
->number
;
750 ctx
->last
= subcase
->number
;
752 /* succeed or fault in only one way? */
753 if (status
== subcase
->expected
)
756 /* async unlink for cleanup? */
757 else if (status
!= -ECONNRESET
) {
759 /* some faults are allowed, not required */
760 if (subcase
->expected
> 0 && (
761 ((status
== -subcase
->expected
/* happened */
762 || status
== 0)))) /* didn't */
764 /* sometimes more than one fault is allowed */
765 else if (subcase
->number
== 12 && status
== -EPIPE
)
768 ERROR(ctx
->dev
, "subtest %d error, status %d\n",
769 subcase
->number
, status
);
772 /* unexpected status codes mean errors; ideally, in hardware */
775 if (ctx
->status
== 0) {
778 ctx
->status
= status
;
779 ERROR(ctx
->dev
, "control queue %02x.%02x, err %d, "
780 "%d left, subcase %d, len %d/%d\n",
781 reqp
->bRequestType
, reqp
->bRequest
,
782 status
, ctx
->count
, subcase
->number
,
784 urb
->transfer_buffer_length
);
786 /* FIXME this "unlink everything" exit route should
787 * be a separate test case.
790 /* unlink whatever's still pending */
791 for (i
= 1; i
< ctx
->param
->sglen
; i
++) {
792 struct urb
*u
= ctx
->urb
[
793 (i
+ subcase
->number
)
794 % ctx
->param
->sglen
];
796 if (u
== urb
|| !u
->dev
)
798 spin_unlock(&ctx
->lock
);
799 status
= usb_unlink_urb(u
);
800 spin_lock(&ctx
->lock
);
807 ERROR(ctx
->dev
, "urb unlink --> %d\n",
811 status
= ctx
->status
;
815 /* resubmit if we need to, else mark this as done */
816 if ((status
== 0) && (ctx
->pending
< ctx
->count
)) {
817 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
820 "can't resubmit ctrl %02x.%02x, err %d\n",
821 reqp
->bRequestType
, reqp
->bRequest
, status
);
828 /* signal completion when nothing's queued */
829 if (ctx
->pending
== 0)
830 complete(&ctx
->complete
);
831 spin_unlock(&ctx
->lock
);
835 test_ctrl_queue(struct usbtest_dev
*dev
, struct usbtest_param
*param
)
837 struct usb_device
*udev
= testdev_to_usbdev(dev
);
839 struct ctrl_ctx context
;
842 spin_lock_init(&context
.lock
);
844 init_completion(&context
.complete
);
845 context
.count
= param
->sglen
* param
->iterations
;
847 context
.status
= -ENOMEM
;
848 context
.param
= param
;
851 /* allocate and init the urbs we'll queue.
852 * as with bulk/intr sglists, sglen is the queue depth; it also
853 * controls which subtests run (more tests than sglen) or rerun.
855 urb
= kcalloc(param
->sglen
, sizeof(struct urb
*), GFP_KERNEL
);
858 for (i
= 0; i
< param
->sglen
; i
++) {
859 int pipe
= usb_rcvctrlpipe(udev
, 0);
862 struct usb_ctrlrequest req
;
863 struct subcase
*reqp
;
865 /* sign of this variable means:
866 * -: tested code must return this (negative) error code
867 * +: tested code may return this (negative too) error code
871 /* requests here are mostly expected to succeed on any
872 * device, but some are chosen to trigger protocol stalls
875 memset(&req
, 0, sizeof req
);
876 req
.bRequest
= USB_REQ_GET_DESCRIPTOR
;
877 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_DEVICE
;
879 switch (i
% NUM_SUBCASES
) {
880 case 0: /* get device descriptor */
881 req
.wValue
= cpu_to_le16(USB_DT_DEVICE
<< 8);
882 len
= sizeof(struct usb_device_descriptor
);
884 case 1: /* get first config descriptor (only) */
885 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
886 len
= sizeof(struct usb_config_descriptor
);
888 case 2: /* get altsetting (OFTEN STALLS) */
889 req
.bRequest
= USB_REQ_GET_INTERFACE
;
890 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_INTERFACE
;
891 /* index = 0 means first interface */
895 case 3: /* get interface status */
896 req
.bRequest
= USB_REQ_GET_STATUS
;
897 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_INTERFACE
;
901 case 4: /* get device status */
902 req
.bRequest
= USB_REQ_GET_STATUS
;
903 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_DEVICE
;
906 case 5: /* get device qualifier (MAY STALL) */
907 req
.wValue
= cpu_to_le16 (USB_DT_DEVICE_QUALIFIER
<< 8);
908 len
= sizeof(struct usb_qualifier_descriptor
);
909 if (udev
->speed
!= USB_SPEED_HIGH
)
912 case 6: /* get first config descriptor, plus interface */
913 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
914 len
= sizeof(struct usb_config_descriptor
);
915 len
+= sizeof(struct usb_interface_descriptor
);
917 case 7: /* get interface descriptor (ALWAYS STALLS) */
918 req
.wValue
= cpu_to_le16 (USB_DT_INTERFACE
<< 8);
920 len
= sizeof(struct usb_interface_descriptor
);
923 /* NOTE: two consecutive stalls in the queue here.
924 * that tests fault recovery a bit more aggressively. */
925 case 8: /* clear endpoint halt (MAY STALL) */
926 req
.bRequest
= USB_REQ_CLEAR_FEATURE
;
927 req
.bRequestType
= USB_RECIP_ENDPOINT
;
928 /* wValue 0 == ep halt */
929 /* wIndex 0 == ep0 (shouldn't halt!) */
931 pipe
= usb_sndctrlpipe(udev
, 0);
934 case 9: /* get endpoint status */
935 req
.bRequest
= USB_REQ_GET_STATUS
;
936 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_ENDPOINT
;
940 case 10: /* trigger short read (EREMOTEIO) */
941 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
943 expected
= -EREMOTEIO
;
945 /* NOTE: two consecutive _different_ faults in the queue. */
946 case 11: /* get endpoint descriptor (ALWAYS STALLS) */
947 req
.wValue
= cpu_to_le16(USB_DT_ENDPOINT
<< 8);
949 len
= sizeof(struct usb_interface_descriptor
);
952 /* NOTE: sometimes even a third fault in the queue! */
953 case 12: /* get string 0 descriptor (MAY STALL) */
954 req
.wValue
= cpu_to_le16(USB_DT_STRING
<< 8);
955 /* string == 0, for language IDs */
956 len
= sizeof(struct usb_interface_descriptor
);
957 /* may succeed when > 4 languages */
958 expected
= EREMOTEIO
; /* or EPIPE, if no strings */
960 case 13: /* short read, resembling case 10 */
961 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
962 /* last data packet "should" be DATA1, not DATA0 */
963 len
= 1024 - udev
->descriptor
.bMaxPacketSize0
;
964 expected
= -EREMOTEIO
;
966 case 14: /* short read; try to fill the last packet */
967 req
.wValue
= cpu_to_le16((USB_DT_DEVICE
<< 8) | 0);
968 /* device descriptor size == 18 bytes */
969 len
= udev
->descriptor
.bMaxPacketSize0
;
978 expected
= -EREMOTEIO
;
981 ERROR(dev
, "bogus number of ctrl queue testcases!\n");
982 context
.status
= -EINVAL
;
985 req
.wLength
= cpu_to_le16(len
);
986 urb
[i
] = u
= simple_alloc_urb(udev
, pipe
, len
);
990 reqp
= kmalloc(sizeof *reqp
, GFP_KERNEL
);
994 reqp
->number
= i
% NUM_SUBCASES
;
995 reqp
->expected
= expected
;
996 u
->setup_packet
= (char *) &reqp
->setup
;
998 u
->context
= &context
;
999 u
->complete
= ctrl_complete
;
1002 /* queue the urbs */
1004 spin_lock_irq(&context
.lock
);
1005 for (i
= 0; i
< param
->sglen
; i
++) {
1006 context
.status
= usb_submit_urb(urb
[i
], GFP_ATOMIC
);
1007 if (context
.status
!= 0) {
1008 ERROR(dev
, "can't submit urb[%d], status %d\n",
1010 context
.count
= context
.pending
;
1015 spin_unlock_irq(&context
.lock
);
1017 /* FIXME set timer and time out; provide a disconnect hook */
1019 /* wait for the last one to complete */
1020 if (context
.pending
> 0)
1021 wait_for_completion(&context
.complete
);
1024 for (i
= 0; i
< param
->sglen
; i
++) {
1028 kfree(urb
[i
]->setup_packet
);
1029 simple_free_urb(urb
[i
]);
1032 return context
.status
;
1037 /*-------------------------------------------------------------------------*/
1039 static void unlink1_callback(struct urb
*urb
)
1041 int status
= urb
->status
;
1043 /* we "know" -EPIPE (stall) never happens */
1045 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
1047 urb
->status
= status
;
1048 complete(urb
->context
);
1052 static int unlink1(struct usbtest_dev
*dev
, int pipe
, int size
, int async
)
1055 struct completion completion
;
1058 init_completion(&completion
);
1059 urb
= simple_alloc_urb(testdev_to_usbdev(dev
), pipe
, size
);
1062 urb
->context
= &completion
;
1063 urb
->complete
= unlink1_callback
;
1065 /* keep the endpoint busy. there are lots of hc/hcd-internal
1066 * states, and testing should get to all of them over time.
1068 * FIXME want additional tests for when endpoint is STALLing
1069 * due to errors, or is just NAKing requests.
1071 retval
= usb_submit_urb(urb
, GFP_KERNEL
);
1073 dev_err(&dev
->intf
->dev
, "submit fail %d\n", retval
);
1077 /* unlinking that should always work. variable delay tests more
1078 * hcd states and code paths, even with little other system load.
1080 msleep(jiffies
% (2 * INTERRUPT_RATE
));
1082 while (!completion_done(&completion
)) {
1083 retval
= usb_unlink_urb(urb
);
1088 /* we can't unlink urbs while they're completing
1089 * or if they've completed, and we haven't
1090 * resubmitted. "normal" drivers would prevent
1091 * resubmission, but since we're testing unlink
1094 ERROR(dev
, "unlink retry\n");
1101 dev_err(&dev
->intf
->dev
,
1102 "unlink fail %d\n", retval
);
1111 wait_for_completion(&completion
);
1112 retval
= urb
->status
;
1113 simple_free_urb(urb
);
1116 return (retval
== -ECONNRESET
) ? 0 : retval
- 1000;
1118 return (retval
== -ENOENT
|| retval
== -EPERM
) ?
1122 static int unlink_simple(struct usbtest_dev
*dev
, int pipe
, int len
)
1126 /* test sync and async paths */
1127 retval
= unlink1(dev
, pipe
, len
, 1);
1129 retval
= unlink1(dev
, pipe
, len
, 0);
1133 /*-------------------------------------------------------------------------*/
1135 static int verify_not_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1140 /* shouldn't look or act halted */
1141 retval
= usb_get_status(urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1143 ERROR(tdev
, "ep %02x couldn't get no-halt status, %d\n",
1148 ERROR(tdev
, "ep %02x bogus status: %04x != 0\n", ep
, status
);
1151 retval
= simple_io(tdev
, urb
, 1, 0, 0, __func__
);
1157 static int verify_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1162 /* should look and act halted */
1163 retval
= usb_get_status(urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1165 ERROR(tdev
, "ep %02x couldn't get halt status, %d\n",
1169 le16_to_cpus(&status
);
1171 ERROR(tdev
, "ep %02x bogus status: %04x != 1\n", ep
, status
);
1174 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, __func__
);
1175 if (retval
!= -EPIPE
)
1177 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, "verify_still_halted");
1178 if (retval
!= -EPIPE
)
1183 static int test_halt(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1187 /* shouldn't look or act halted now */
1188 retval
= verify_not_halted(tdev
, ep
, urb
);
1192 /* set halt (protocol test only), verify it worked */
1193 retval
= usb_control_msg(urb
->dev
, usb_sndctrlpipe(urb
->dev
, 0),
1194 USB_REQ_SET_FEATURE
, USB_RECIP_ENDPOINT
,
1195 USB_ENDPOINT_HALT
, ep
,
1196 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1198 ERROR(tdev
, "ep %02x couldn't set halt, %d\n", ep
, retval
);
1201 retval
= verify_halted(tdev
, ep
, urb
);
1205 /* clear halt (tests API + protocol), verify it worked */
1206 retval
= usb_clear_halt(urb
->dev
, urb
->pipe
);
1208 ERROR(tdev
, "ep %02x couldn't clear halt, %d\n", ep
, retval
);
1211 retval
= verify_not_halted(tdev
, ep
, urb
);
1215 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1220 static int halt_simple(struct usbtest_dev
*dev
)
1226 urb
= simple_alloc_urb(testdev_to_usbdev(dev
), 0, 512);
1231 ep
= usb_pipeendpoint(dev
->in_pipe
) | USB_DIR_IN
;
1232 urb
->pipe
= dev
->in_pipe
;
1233 retval
= test_halt(dev
, ep
, urb
);
1238 if (dev
->out_pipe
) {
1239 ep
= usb_pipeendpoint(dev
->out_pipe
);
1240 urb
->pipe
= dev
->out_pipe
;
1241 retval
= test_halt(dev
, ep
, urb
);
1244 simple_free_urb(urb
);
1248 /*-------------------------------------------------------------------------*/
1250 /* Control OUT tests use the vendor control requests from Intel's
1251 * USB 2.0 compliance test device: write a buffer, read it back.
1253 * Intel's spec only _requires_ that it work for one packet, which
1254 * is pretty weak. Some HCDs place limits here; most devices will
1255 * need to be able to handle more than one OUT data packet. We'll
1256 * try whatever we're told to try.
1258 static int ctrl_out(struct usbtest_dev
*dev
,
1259 unsigned count
, unsigned length
, unsigned vary
)
1265 struct usb_device
*udev
;
1267 if (length
< 1 || length
> 0xffff || vary
>= length
)
1270 buf
= kmalloc(length
, GFP_KERNEL
);
1274 udev
= testdev_to_usbdev(dev
);
1278 /* NOTE: hardware might well act differently if we pushed it
1279 * with lots back-to-back queued requests.
1281 for (i
= 0; i
< count
; i
++) {
1282 /* write patterned data */
1283 for (j
= 0; j
< len
; j
++)
1285 retval
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1286 0x5b, USB_DIR_OUT
|USB_TYPE_VENDOR
,
1287 0, 0, buf
, len
, USB_CTRL_SET_TIMEOUT
);
1288 if (retval
!= len
) {
1291 ERROR(dev
, "ctrl_out, wlen %d (expected %d)\n",
1298 /* read it back -- assuming nothing intervened!! */
1299 retval
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
1300 0x5c, USB_DIR_IN
|USB_TYPE_VENDOR
,
1301 0, 0, buf
, len
, USB_CTRL_GET_TIMEOUT
);
1302 if (retval
!= len
) {
1305 ERROR(dev
, "ctrl_out, rlen %d (expected %d)\n",
1312 /* fail if we can't verify */
1313 for (j
= 0; j
< len
; j
++) {
1314 if (buf
[j
] != (u8
) (i
+ j
)) {
1315 ERROR(dev
, "ctrl_out, byte %d is %d not %d\n",
1316 j
, buf
[j
], (u8
) i
+ j
);
1328 /* [real world] the "zero bytes IN" case isn't really used.
1329 * hardware can easily trip up in this weird case, since its
1330 * status stage is IN, not OUT like other ep0in transfers.
1333 len
= realworld
? 1 : 0;
1337 ERROR(dev
, "ctrl_out %s failed, code %d, count %d\n",
1344 /*-------------------------------------------------------------------------*/
1346 /* ISO tests ... mimics common usage
1347 * - buffer length is split into N packets (mostly maxpacket sized)
1348 * - multi-buffers according to sglen
1351 struct iso_context
{
1355 struct completion done
;
1357 unsigned long errors
;
1358 unsigned long packet_count
;
1359 struct usbtest_dev
*dev
;
1362 static void iso_callback(struct urb
*urb
)
1364 struct iso_context
*ctx
= urb
->context
;
1366 spin_lock(&ctx
->lock
);
1369 ctx
->packet_count
+= urb
->number_of_packets
;
1370 if (urb
->error_count
> 0)
1371 ctx
->errors
+= urb
->error_count
;
1372 else if (urb
->status
!= 0)
1373 ctx
->errors
+= urb
->number_of_packets
;
1374 else if (urb
->actual_length
!= urb
->transfer_buffer_length
)
1377 if (urb
->status
== 0 && ctx
->count
> (ctx
->pending
- 1)
1378 && !ctx
->submit_error
) {
1379 int status
= usb_submit_urb(urb
, GFP_ATOMIC
);
1384 dev_err(&ctx
->dev
->intf
->dev
,
1385 "iso resubmit err %d\n",
1388 case -ENODEV
: /* disconnected */
1389 case -ESHUTDOWN
: /* endpoint disabled */
1390 ctx
->submit_error
= 1;
1396 if (ctx
->pending
== 0) {
1398 dev_err(&ctx
->dev
->intf
->dev
,
1399 "iso test, %lu errors out of %lu\n",
1400 ctx
->errors
, ctx
->packet_count
);
1401 complete(&ctx
->done
);
1404 spin_unlock(&ctx
->lock
);
1407 static struct urb
*iso_alloc_urb(
1408 struct usb_device
*udev
,
1410 struct usb_endpoint_descriptor
*desc
,
1415 unsigned i
, maxp
, packets
;
1417 if (bytes
< 0 || !desc
)
1419 maxp
= 0x7ff & le16_to_cpu(desc
->wMaxPacketSize
);
1420 maxp
*= 1 + (0x3 & (le16_to_cpu(desc
->wMaxPacketSize
) >> 11));
1421 packets
= DIV_ROUND_UP(bytes
, maxp
);
1423 urb
= usb_alloc_urb(packets
, GFP_KERNEL
);
1429 urb
->number_of_packets
= packets
;
1430 urb
->transfer_buffer_length
= bytes
;
1431 urb
->transfer_buffer
= usb_alloc_coherent(udev
, bytes
, GFP_KERNEL
,
1432 &urb
->transfer_dma
);
1433 if (!urb
->transfer_buffer
) {
1437 memset(urb
->transfer_buffer
, 0, bytes
);
1438 for (i
= 0; i
< packets
; i
++) {
1439 /* here, only the last packet will be short */
1440 urb
->iso_frame_desc
[i
].length
= min((unsigned) bytes
, maxp
);
1441 bytes
-= urb
->iso_frame_desc
[i
].length
;
1443 urb
->iso_frame_desc
[i
].offset
= maxp
* i
;
1446 urb
->complete
= iso_callback
;
1447 /* urb->context = SET BY CALLER */
1448 urb
->interval
= 1 << (desc
->bInterval
- 1);
1449 urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
1454 test_iso_queue(struct usbtest_dev
*dev
, struct usbtest_param
*param
,
1455 int pipe
, struct usb_endpoint_descriptor
*desc
)
1457 struct iso_context context
;
1458 struct usb_device
*udev
;
1460 unsigned long packets
= 0;
1462 struct urb
*urbs
[10]; /* FIXME no limit */
1464 if (param
->sglen
> 10)
1467 memset(&context
, 0, sizeof context
);
1468 context
.count
= param
->iterations
* param
->sglen
;
1470 init_completion(&context
.done
);
1471 spin_lock_init(&context
.lock
);
1473 memset(urbs
, 0, sizeof urbs
);
1474 udev
= testdev_to_usbdev(dev
);
1475 dev_info(&dev
->intf
->dev
,
1476 "... iso period %d %sframes, wMaxPacket %04x\n",
1477 1 << (desc
->bInterval
- 1),
1478 (udev
->speed
== USB_SPEED_HIGH
) ? "micro" : "",
1479 le16_to_cpu(desc
->wMaxPacketSize
));
1481 for (i
= 0; i
< param
->sglen
; i
++) {
1482 urbs
[i
] = iso_alloc_urb(udev
, pipe
, desc
,
1488 packets
+= urbs
[i
]->number_of_packets
;
1489 urbs
[i
]->context
= &context
;
1491 packets
*= param
->iterations
;
1492 dev_info(&dev
->intf
->dev
,
1493 "... total %lu msec (%lu packets)\n",
1494 (packets
* (1 << (desc
->bInterval
- 1)))
1495 / ((udev
->speed
== USB_SPEED_HIGH
) ? 8 : 1),
1498 spin_lock_irq(&context
.lock
);
1499 for (i
= 0; i
< param
->sglen
; i
++) {
1501 status
= usb_submit_urb(urbs
[i
], GFP_ATOMIC
);
1503 ERROR(dev
, "submit iso[%d], error %d\n", i
, status
);
1505 spin_unlock_irq(&context
.lock
);
1509 simple_free_urb(urbs
[i
]);
1512 context
.submit_error
= 1;
1516 spin_unlock_irq(&context
.lock
);
1518 wait_for_completion(&context
.done
);
1520 for (i
= 0; i
< param
->sglen
; i
++) {
1522 simple_free_urb(urbs
[i
]);
1525 * Isochronous transfers are expected to fail sometimes. As an
1526 * arbitrary limit, we will report an error if any submissions
1527 * fail or if the transfer failure rate is > 10%.
1531 else if (context
.submit_error
)
1533 else if (context
.errors
> context
.packet_count
/ 10)
1538 for (i
= 0; i
< param
->sglen
; i
++) {
1540 simple_free_urb(urbs
[i
]);
1545 /*-------------------------------------------------------------------------*/
1547 /* We only have this one interface to user space, through usbfs.
1548 * User mode code can scan usbfs to find N different devices (maybe on
1549 * different busses) to use when testing, and allocate one thread per
1550 * test. So discovery is simplified, and we have no device naming issues.
1552 * Don't use these only as stress/load tests. Use them along with with
1553 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1554 * video capture, and so on. Run different tests at different times, in
1555 * different sequences. Nothing here should interact with other devices,
1556 * except indirectly by consuming USB bandwidth and CPU resources for test
1557 * threads and request completion. But the only way to know that for sure
1558 * is to test when HC queues are in use by many devices.
1560 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
1561 * it locks out usbcore in certain code paths. Notably, if you disconnect
1562 * the device-under-test, khubd will wait block forever waiting for the
1563 * ioctl to complete ... so that usb_disconnect() can abort the pending
1564 * urbs and then call usbtest_disconnect(). To abort a test, you're best
1565 * off just killing the userspace task and waiting for it to exit.
1570 usbtest_ioctl(struct usb_interface
*intf
, unsigned int code
, void *buf
)
1572 struct usbtest_dev
*dev
= usb_get_intfdata(intf
);
1573 struct usb_device
*udev
= testdev_to_usbdev(dev
);
1574 struct usbtest_param
*param
= buf
;
1575 int retval
= -EOPNOTSUPP
;
1577 struct scatterlist
*sg
;
1578 struct usb_sg_request req
;
1579 struct timeval start
;
1582 /* FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is. */
1584 pattern
= mod_pattern
;
1586 if (code
!= USBTEST_REQUEST
)
1589 if (param
->iterations
<= 0)
1592 if (mutex_lock_interruptible(&dev
->lock
))
1593 return -ERESTARTSYS
;
1595 /* FIXME: What if a system sleep starts while a test is running? */
1597 /* some devices, like ez-usb default devices, need a non-default
1598 * altsetting to have any active endpoints. some tests change
1599 * altsettings; force a default so most tests don't need to check.
1601 if (dev
->info
->alt
>= 0) {
1604 if (intf
->altsetting
->desc
.bInterfaceNumber
) {
1605 mutex_unlock(&dev
->lock
);
1608 res
= set_altsetting(dev
, dev
->info
->alt
);
1611 "set altsetting to %d failed, %d\n",
1612 dev
->info
->alt
, res
);
1613 mutex_unlock(&dev
->lock
);
1619 * Just a bunch of test cases that every HCD is expected to handle.
1621 * Some may need specific firmware, though it'd be good to have
1622 * one firmware image to handle all the test cases.
1624 * FIXME add more tests! cancel requests, verify the data, control
1625 * queueing, concurrent read+write threads, and so on.
1627 do_gettimeofday(&start
);
1628 switch (param
->test_num
) {
1631 dev_info(&intf
->dev
, "TEST 0: NOP\n");
1635 /* Simple non-queued bulk I/O tests */
1637 if (dev
->out_pipe
== 0)
1639 dev_info(&intf
->dev
,
1640 "TEST 1: write %d bytes %u times\n",
1641 param
->length
, param
->iterations
);
1642 urb
= simple_alloc_urb(udev
, dev
->out_pipe
, param
->length
);
1647 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1648 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test1");
1649 simple_free_urb(urb
);
1652 if (dev
->in_pipe
== 0)
1654 dev_info(&intf
->dev
,
1655 "TEST 2: read %d bytes %u times\n",
1656 param
->length
, param
->iterations
);
1657 urb
= simple_alloc_urb(udev
, dev
->in_pipe
, param
->length
);
1662 /* FIRMWARE: bulk source (maybe generates short writes) */
1663 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test2");
1664 simple_free_urb(urb
);
1667 if (dev
->out_pipe
== 0 || param
->vary
== 0)
1669 dev_info(&intf
->dev
,
1670 "TEST 3: write/%d 0..%d bytes %u times\n",
1671 param
->vary
, param
->length
, param
->iterations
);
1672 urb
= simple_alloc_urb(udev
, dev
->out_pipe
, param
->length
);
1677 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1678 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
1680 simple_free_urb(urb
);
1683 if (dev
->in_pipe
== 0 || param
->vary
== 0)
1685 dev_info(&intf
->dev
,
1686 "TEST 4: read/%d 0..%d bytes %u times\n",
1687 param
->vary
, param
->length
, param
->iterations
);
1688 urb
= simple_alloc_urb(udev
, dev
->in_pipe
, param
->length
);
1693 /* FIRMWARE: bulk source (maybe generates short writes) */
1694 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
1696 simple_free_urb(urb
);
1699 /* Queued bulk I/O tests */
1701 if (dev
->out_pipe
== 0 || param
->sglen
== 0)
1703 dev_info(&intf
->dev
,
1704 "TEST 5: write %d sglists %d entries of %d bytes\n",
1706 param
->sglen
, param
->length
);
1707 sg
= alloc_sglist(param
->sglen
, param
->length
, 0);
1712 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1713 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
1714 &req
, sg
, param
->sglen
);
1715 free_sglist(sg
, param
->sglen
);
1719 if (dev
->in_pipe
== 0 || param
->sglen
== 0)
1721 dev_info(&intf
->dev
,
1722 "TEST 6: read %d sglists %d entries of %d bytes\n",
1724 param
->sglen
, param
->length
);
1725 sg
= alloc_sglist(param
->sglen
, param
->length
, 0);
1730 /* FIRMWARE: bulk source (maybe generates short writes) */
1731 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
1732 &req
, sg
, param
->sglen
);
1733 free_sglist(sg
, param
->sglen
);
1736 if (dev
->out_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
1738 dev_info(&intf
->dev
,
1739 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1740 param
->vary
, param
->iterations
,
1741 param
->sglen
, param
->length
);
1742 sg
= alloc_sglist(param
->sglen
, param
->length
, param
->vary
);
1747 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1748 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
1749 &req
, sg
, param
->sglen
);
1750 free_sglist(sg
, param
->sglen
);
1753 if (dev
->in_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
1755 dev_info(&intf
->dev
,
1756 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1757 param
->vary
, param
->iterations
,
1758 param
->sglen
, param
->length
);
1759 sg
= alloc_sglist(param
->sglen
, param
->length
, param
->vary
);
1764 /* FIRMWARE: bulk source (maybe generates short writes) */
1765 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
1766 &req
, sg
, param
->sglen
);
1767 free_sglist(sg
, param
->sglen
);
1770 /* non-queued sanity tests for control (chapter 9 subset) */
1773 dev_info(&intf
->dev
,
1774 "TEST 9: ch9 (subset) control tests, %d times\n",
1776 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1777 retval
= ch9_postconfig(dev
);
1779 dev_err(&intf
->dev
, "ch9 subset failed, "
1780 "iterations left %d\n", i
);
1783 /* queued control messaging */
1785 if (param
->sglen
== 0)
1788 dev_info(&intf
->dev
,
1789 "TEST 10: queue %d control calls, %d times\n",
1792 retval
= test_ctrl_queue(dev
, param
);
1795 /* simple non-queued unlinks (ring with one urb) */
1797 if (dev
->in_pipe
== 0 || !param
->length
)
1800 dev_info(&intf
->dev
, "TEST 11: unlink %d reads of %d\n",
1801 param
->iterations
, param
->length
);
1802 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1803 retval
= unlink_simple(dev
, dev
->in_pipe
,
1806 dev_err(&intf
->dev
, "unlink reads failed %d, "
1807 "iterations left %d\n", retval
, i
);
1810 if (dev
->out_pipe
== 0 || !param
->length
)
1813 dev_info(&intf
->dev
, "TEST 12: unlink %d writes of %d\n",
1814 param
->iterations
, param
->length
);
1815 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1816 retval
= unlink_simple(dev
, dev
->out_pipe
,
1819 dev_err(&intf
->dev
, "unlink writes failed %d, "
1820 "iterations left %d\n", retval
, i
);
1825 if (dev
->out_pipe
== 0 && dev
->in_pipe
== 0)
1828 dev_info(&intf
->dev
, "TEST 13: set/clear %d halts\n",
1830 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1831 retval
= halt_simple(dev
);
1834 ERROR(dev
, "halts failed, iterations left %d\n", i
);
1837 /* control write tests */
1839 if (!dev
->info
->ctrl_out
)
1841 dev_info(&intf
->dev
, "TEST 14: %d ep0out, %d..%d vary %d\n",
1843 realworld
? 1 : 0, param
->length
,
1845 retval
= ctrl_out(dev
, param
->iterations
,
1846 param
->length
, param
->vary
);
1849 /* iso write tests */
1851 if (dev
->out_iso_pipe
== 0 || param
->sglen
== 0)
1853 dev_info(&intf
->dev
,
1854 "TEST 15: write %d iso, %d entries of %d bytes\n",
1856 param
->sglen
, param
->length
);
1857 /* FIRMWARE: iso sink */
1858 retval
= test_iso_queue(dev
, param
,
1859 dev
->out_iso_pipe
, dev
->iso_out
);
1862 /* iso read tests */
1864 if (dev
->in_iso_pipe
== 0 || param
->sglen
== 0)
1866 dev_info(&intf
->dev
,
1867 "TEST 16: read %d iso, %d entries of %d bytes\n",
1869 param
->sglen
, param
->length
);
1870 /* FIRMWARE: iso source */
1871 retval
= test_iso_queue(dev
, param
,
1872 dev
->in_iso_pipe
, dev
->iso_in
);
1875 /* FIXME unlink from queue (ring with N urbs) */
1877 /* FIXME scatterlist cancel (needs helper thread) */
1880 do_gettimeofday(¶m
->duration
);
1881 param
->duration
.tv_sec
-= start
.tv_sec
;
1882 param
->duration
.tv_usec
-= start
.tv_usec
;
1883 if (param
->duration
.tv_usec
< 0) {
1884 param
->duration
.tv_usec
+= 1000 * 1000;
1885 param
->duration
.tv_sec
-= 1;
1887 mutex_unlock(&dev
->lock
);
1891 /*-------------------------------------------------------------------------*/
1893 static unsigned force_interrupt
;
1894 module_param(force_interrupt
, uint
, 0);
1895 MODULE_PARM_DESC(force_interrupt
, "0 = test default; else interrupt");
1898 static unsigned short vendor
;
1899 module_param(vendor
, ushort
, 0);
1900 MODULE_PARM_DESC(vendor
, "vendor code (from usb-if)");
1902 static unsigned short product
;
1903 module_param(product
, ushort
, 0);
1904 MODULE_PARM_DESC(product
, "product code (from vendor)");
1908 usbtest_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1910 struct usb_device
*udev
;
1911 struct usbtest_dev
*dev
;
1912 struct usbtest_info
*info
;
1913 char *rtest
, *wtest
;
1914 char *irtest
, *iwtest
;
1916 udev
= interface_to_usbdev(intf
);
1919 /* specify devices by module parameters? */
1920 if (id
->match_flags
== 0) {
1921 /* vendor match required, product match optional */
1922 if (!vendor
|| le16_to_cpu(udev
->descriptor
.idVendor
) != (u16
)vendor
)
1924 if (product
&& le16_to_cpu(udev
->descriptor
.idProduct
) != (u16
)product
)
1926 dev_info(&intf
->dev
, "matched module params, "
1927 "vend=0x%04x prod=0x%04x\n",
1928 le16_to_cpu(udev
->descriptor
.idVendor
),
1929 le16_to_cpu(udev
->descriptor
.idProduct
));
1933 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
1936 info
= (struct usbtest_info
*) id
->driver_info
;
1938 mutex_init(&dev
->lock
);
1942 /* cacheline-aligned scratch for i/o */
1943 dev
->buf
= kmalloc(TBUF_SIZE
, GFP_KERNEL
);
1944 if (dev
->buf
== NULL
) {
1949 /* NOTE this doesn't yet test the handful of difference that are
1950 * visible with high speed interrupts: bigger maxpacket (1K) and
1951 * "high bandwidth" modes (up to 3 packets/uframe).
1954 irtest
= iwtest
= "";
1955 if (force_interrupt
|| udev
->speed
== USB_SPEED_LOW
) {
1957 dev
->in_pipe
= usb_rcvintpipe(udev
, info
->ep_in
);
1961 dev
->out_pipe
= usb_sndintpipe(udev
, info
->ep_out
);
1962 wtest
= " intr-out";
1965 if (info
->autoconf
) {
1968 status
= get_endpoints(dev
, intf
);
1970 WARNING(dev
, "couldn't get endpoints, %d\n",
1974 /* may find bulk or ISO pipes */
1977 dev
->in_pipe
= usb_rcvbulkpipe(udev
,
1980 dev
->out_pipe
= usb_sndbulkpipe(udev
,
1986 wtest
= " bulk-out";
1987 if (dev
->in_iso_pipe
)
1989 if (dev
->out_iso_pipe
)
1990 iwtest
= " iso-out";
1993 usb_set_intfdata(intf
, dev
);
1994 dev_info(&intf
->dev
, "%s\n", info
->name
);
1995 dev_info(&intf
->dev
, "%s speed {control%s%s%s%s%s} tests%s\n",
1997 switch (udev
->speed
) {
2001 case USB_SPEED_FULL
:
2004 case USB_SPEED_HIGH
:
2011 info
->ctrl_out
? " in/out" : "",
2014 info
->alt
>= 0 ? " (+alt)" : "");
2018 static int usbtest_suspend(struct usb_interface
*intf
, pm_message_t message
)
2023 static int usbtest_resume(struct usb_interface
*intf
)
2029 static void usbtest_disconnect(struct usb_interface
*intf
)
2031 struct usbtest_dev
*dev
= usb_get_intfdata(intf
);
2033 usb_set_intfdata(intf
, NULL
);
2034 dev_dbg(&intf
->dev
, "disconnect\n");
2038 /* Basic testing only needs a device that can source or sink bulk traffic.
2039 * Any device can test control transfers (default with GENERIC binding).
2041 * Several entries work with the default EP0 implementation that's built
2042 * into EZ-USB chips. There's a default vendor ID which can be overridden
2043 * by (very) small config EEPROMS, but otherwise all these devices act
2044 * identically until firmware is loaded: only EP0 works. It turns out
2045 * to be easy to make other endpoints work, without modifying that EP0
2046 * behavior. For now, we expect that kind of firmware.
2049 /* an21xx or fx versions of ez-usb */
2050 static struct usbtest_info ez1_info
= {
2051 .name
= "EZ-USB device",
2057 /* fx2 version of ez-usb */
2058 static struct usbtest_info ez2_info
= {
2059 .name
= "FX2 device",
2065 /* ezusb family device with dedicated usb test firmware,
2067 static struct usbtest_info fw_info
= {
2068 .name
= "usb test device",
2072 .autoconf
= 1, /* iso and ctrl_out need autoconf */
2074 .iso
= 1, /* iso_ep's are #8 in/out */
2077 /* peripheral running Linux and 'zero.c' test firmware, or
2078 * its user-mode cousin. different versions of this use
2079 * different hardware with the same vendor/product codes.
2080 * host side MUST rely on the endpoint descriptors.
2082 static struct usbtest_info gz_info
= {
2083 .name
= "Linux gadget zero",
2089 static struct usbtest_info um_info
= {
2090 .name
= "Linux user mode test driver",
2095 static struct usbtest_info um2_info
= {
2096 .name
= "Linux user mode ISO test driver",
2103 /* this is a nice source of high speed bulk data;
2104 * uses an FX2, with firmware provided in the device
2106 static struct usbtest_info ibot2_info
= {
2107 .name
= "iBOT2 webcam",
2114 /* we can use any device to test control traffic */
2115 static struct usbtest_info generic_info
= {
2116 .name
= "Generic USB device",
2122 static const struct usb_device_id id_table
[] = {
2124 /*-------------------------------------------------------------*/
2126 /* EZ-USB devices which download firmware to replace (or in our
2127 * case augment) the default device implementation.
2130 /* generic EZ-USB FX controller */
2131 { USB_DEVICE(0x0547, 0x2235),
2132 .driver_info
= (unsigned long) &ez1_info
,
2135 /* CY3671 development board with EZ-USB FX */
2136 { USB_DEVICE(0x0547, 0x0080),
2137 .driver_info
= (unsigned long) &ez1_info
,
2140 /* generic EZ-USB FX2 controller (or development board) */
2141 { USB_DEVICE(0x04b4, 0x8613),
2142 .driver_info
= (unsigned long) &ez2_info
,
2145 /* re-enumerated usb test device firmware */
2146 { USB_DEVICE(0xfff0, 0xfff0),
2147 .driver_info
= (unsigned long) &fw_info
,
2150 /* "Gadget Zero" firmware runs under Linux */
2151 { USB_DEVICE(0x0525, 0xa4a0),
2152 .driver_info
= (unsigned long) &gz_info
,
2155 /* so does a user-mode variant */
2156 { USB_DEVICE(0x0525, 0xa4a4),
2157 .driver_info
= (unsigned long) &um_info
,
2160 /* ... and a user-mode variant that talks iso */
2161 { USB_DEVICE(0x0525, 0xa4a3),
2162 .driver_info
= (unsigned long) &um2_info
,
2166 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2167 /* this does not coexist with the real Keyspan 19qi driver! */
2168 { USB_DEVICE(0x06cd, 0x010b),
2169 .driver_info
= (unsigned long) &ez1_info
,
2173 /*-------------------------------------------------------------*/
2176 /* iBOT2 makes a nice source of high speed bulk-in data */
2177 /* this does not coexist with a real iBOT2 driver! */
2178 { USB_DEVICE(0x0b62, 0x0059),
2179 .driver_info
= (unsigned long) &ibot2_info
,
2183 /*-------------------------------------------------------------*/
2186 /* module params can specify devices to use for control tests */
2187 { .driver_info
= (unsigned long) &generic_info
, },
2190 /*-------------------------------------------------------------*/
2194 MODULE_DEVICE_TABLE(usb
, id_table
);
2196 static struct usb_driver usbtest_driver
= {
2198 .id_table
= id_table
,
2199 .probe
= usbtest_probe
,
2200 .unlocked_ioctl
= usbtest_ioctl
,
2201 .disconnect
= usbtest_disconnect
,
2202 .suspend
= usbtest_suspend
,
2203 .resume
= usbtest_resume
,
2206 /*-------------------------------------------------------------------------*/
2208 static int __init
usbtest_init(void)
2212 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor
, product
);
2214 return usb_register(&usbtest_driver
);
2216 module_init(usbtest_init
);
2218 static void __exit
usbtest_exit(void)
2220 usb_deregister(&usbtest_driver
);
2222 module_exit(usbtest_exit
);
2224 MODULE_DESCRIPTION("USB Core/HCD Testing Driver");
2225 MODULE_LICENSE("GPL");