Loading...
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>
6#include <linux/mm.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>
13
14#define SIMPLE_IO_TIMEOUT 10000 /* in milliseconds */
15
16/*-------------------------------------------------------------------------*/
17
18static int override_alt = -1;
19module_param_named(alt, override_alt, int, 0644);
20MODULE_PARM_DESC(alt, ">= 0 to override altsetting selection");
21static void complicated_callback(struct urb *urb);
22
23/*-------------------------------------------------------------------------*/
24
25/* FIXME make these public somewhere; usbdevfs.h? */
26
27/* Parameter for usbtest driver. */
28struct usbtest_param_32 {
29 /* inputs */
30 __u32 test_num; /* 0..(TEST_CASES-1) */
31 __u32 iterations;
32 __u32 length;
33 __u32 vary;
34 __u32 sglen;
35
36 /* outputs */
37 __s32 duration_sec;
38 __s32 duration_usec;
39};
40
41/*
42 * Compat parameter to the usbtest driver.
43 * This supports older user space binaries compiled with 64 bit compiler.
44 */
45struct usbtest_param_64 {
46 /* inputs */
47 __u32 test_num; /* 0..(TEST_CASES-1) */
48 __u32 iterations;
49 __u32 length;
50 __u32 vary;
51 __u32 sglen;
52
53 /* outputs */
54 __s64 duration_sec;
55 __s64 duration_usec;
56};
57
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)
62
63/*-------------------------------------------------------------------------*/
64
65#define GENERIC /* let probe() bind using module params */
66
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
69 * that "real" driver.
70 */
71//#define IBOT2 /* grab iBOT2 webcams */
72//#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
73
74/*-------------------------------------------------------------------------*/
75
76struct usbtest_info {
77 const char *name;
78 u8 ep_in; /* bulk/intr source */
79 u8 ep_out; /* bulk/intr sink */
80 unsigned autoconf:1;
81 unsigned ctrl_out:1;
82 unsigned iso:1; /* try iso in/out */
83 unsigned intr:1; /* try interrupt in/out */
84 int alt;
85};
86
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.
92 */
93struct usbtest_dev {
94 struct usb_interface *intf;
95 struct usbtest_info *info;
96 int in_pipe;
97 int out_pipe;
98 int in_iso_pipe;
99 int out_iso_pipe;
100 int in_int_pipe;
101 int out_int_pipe;
102 struct usb_endpoint_descriptor *iso_in, *iso_out;
103 struct usb_endpoint_descriptor *int_in, *int_out;
104 struct mutex lock;
105
106#define TBUF_SIZE 256
107 u8 *buf;
108};
109
110static struct usb_device *testdev_to_usbdev(struct usbtest_dev *test)
111{
112 return interface_to_usbdev(test->intf);
113}
114
115/* set up all urbs so they can be used with either bulk or interrupt */
116#define INTERRUPT_RATE 1 /* msec/transfer */
117
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)
122
123#define GUARD_BYTE 0xA5
124#define MAX_SGLEN 128
125
126/*-------------------------------------------------------------------------*/
127
128static inline void endpoint_update(int edi,
129 struct usb_host_endpoint **in,
130 struct usb_host_endpoint **out,
131 struct usb_host_endpoint *e)
132{
133 if (edi) {
134 if (!*in)
135 *in = e;
136 } else {
137 if (!*out)
138 *out = e;
139 }
140}
141
142static int
143get_endpoints(struct usbtest_dev *dev, struct usb_interface *intf)
144{
145 int tmp;
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;
151
152 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
153 unsigned ep;
154
155 in = out = NULL;
156 iso_in = iso_out = NULL;
157 int_in = int_out = NULL;
158 alt = intf->altsetting + tmp;
159
160 if (override_alt >= 0 &&
161 override_alt != alt->desc.bAlternateSetting)
162 continue;
163
164 /* take the first altsetting with in-bulk + out-bulk;
165 * ignore other endpoints and altsettings.
166 */
167 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
168 struct usb_host_endpoint *e;
169 int edi;
170
171 e = alt->endpoint + ep;
172 edi = usb_endpoint_dir_in(&e->desc);
173
174 switch (usb_endpoint_type(&e->desc)) {
175 case USB_ENDPOINT_XFER_BULK:
176 endpoint_update(edi, &in, &out, e);
177 continue;
178 case USB_ENDPOINT_XFER_INT:
179 if (dev->info->intr)
180 endpoint_update(edi, &int_in, &int_out, e);
181 continue;
182 case USB_ENDPOINT_XFER_ISOC:
183 if (dev->info->iso)
184 endpoint_update(edi, &iso_in, &iso_out, e);
185 fallthrough;
186 default:
187 continue;
188 }
189 }
190 if ((in && out) || iso_in || iso_out || int_in || int_out)
191 goto found;
192 }
193 return -EINVAL;
194
195found:
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);
202 if (tmp < 0)
203 return tmp;
204 }
205
206 if (in)
207 dev->in_pipe = usb_rcvbulkpipe(udev,
208 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
209 if (out)
210 dev->out_pipe = usb_sndbulkpipe(udev,
211 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
212
213 if (iso_in) {
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);
218 }
219
220 if (iso_out) {
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);
225 }
226
227 if (int_in) {
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);
232 }
233
234 if (int_out) {
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);
239 }
240 return 0;
241}
242
243/*-------------------------------------------------------------------------*/
244
245/* Support for testing basic non-queued I/O streams.
246 *
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.
250 */
251
252static void simple_callback(struct urb *urb)
253{
254 complete(urb->context);
255}
256
257static struct urb *usbtest_alloc_urb(
258 struct usb_device *udev,
259 int pipe,
260 unsigned long bytes,
261 unsigned transfer_flags,
262 unsigned offset,
263 u8 bInterval,
264 usb_complete_t complete_fn)
265{
266 struct urb *urb;
267
268 urb = usb_alloc_urb(0, GFP_KERNEL);
269 if (!urb)
270 return urb;
271
272 if (bInterval)
273 usb_fill_int_urb(urb, udev, pipe, NULL, bytes, complete_fn,
274 NULL, bInterval);
275 else
276 usb_fill_bulk_urb(urb, udev, pipe, NULL, bytes, complete_fn,
277 NULL);
278
279 urb->interval = (udev->speed == USB_SPEED_HIGH)
280 ? (INTERRUPT_RATE << 3)
281 : INTERRUPT_RATE;
282 urb->transfer_flags = transfer_flags;
283 if (usb_pipein(pipe))
284 urb->transfer_flags |= URB_SHORT_NOT_OK;
285
286 if ((bytes + offset) == 0)
287 return urb;
288
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);
292 else
293 urb->transfer_buffer = kmalloc(bytes + offset, GFP_KERNEL);
294
295 if (!urb->transfer_buffer) {
296 usb_free_urb(urb);
297 return NULL;
298 }
299
300 /* To test unaligned transfers add an offset and fill the
301 unused memory with a guard value */
302 if (offset) {
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;
307 }
308
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,
313 bytes);
314 return urb;
315}
316
317static struct urb *simple_alloc_urb(
318 struct usb_device *udev,
319 int pipe,
320 unsigned long bytes,
321 u8 bInterval)
322{
323 return usbtest_alloc_urb(udev, pipe, bytes, URB_NO_TRANSFER_DMA_MAP, 0,
324 bInterval, simple_callback);
325}
326
327static struct urb *complicated_alloc_urb(
328 struct usb_device *udev,
329 int pipe,
330 unsigned long bytes,
331 u8 bInterval)
332{
333 return usbtest_alloc_urb(udev, pipe, bytes, URB_NO_TRANSFER_DMA_MAP, 0,
334 bInterval, complicated_callback);
335}
336
337static unsigned pattern;
338static unsigned mod_pattern;
339module_param_named(pattern, mod_pattern, uint, S_IRUGO | S_IWUSR);
340MODULE_PARM_DESC(mod_pattern, "i/o pattern (0 == zeroes)");
341
342static unsigned get_maxpacket(struct usb_device *udev, int pipe)
343{
344 struct usb_host_endpoint *ep;
345
346 ep = usb_pipe_endpoint(udev, pipe);
347 return le16_to_cpup(&ep->desc.wMaxPacketSize);
348}
349
350static int ss_isoc_get_packet_num(struct usb_device *udev, int pipe)
351{
352 struct usb_host_endpoint *ep = usb_pipe_endpoint(udev, pipe);
353
354 return USB_SS_MULT(ep->ss_ep_comp.bmAttributes)
355 * (1 + ep->ss_ep_comp.bMaxBurst);
356}
357
358static void simple_fill_buf(struct urb *urb)
359{
360 unsigned i;
361 u8 *buf = urb->transfer_buffer;
362 unsigned len = urb->transfer_buffer_length;
363 unsigned maxpacket;
364
365 switch (pattern) {
366 default:
367 fallthrough;
368 case 0:
369 memset(buf, 0, len);
370 break;
371 case 1: /* mod63 */
372 maxpacket = get_maxpacket(urb->dev, urb->pipe);
373 for (i = 0; i < len; i++)
374 *buf++ = (u8) ((i % maxpacket) % 63);
375 break;
376 }
377}
378
379static inline unsigned long buffer_offset(void *buf)
380{
381 return (unsigned long)buf & (ARCH_KMALLOC_MINALIGN - 1);
382}
383
384static int check_guard_bytes(struct usbtest_dev *tdev, struct urb *urb)
385{
386 u8 *buf = urb->transfer_buffer;
387 u8 *guard = buf - buffer_offset(buf);
388 unsigned i;
389
390 for (i = 0; guard < buf; i++, guard++) {
391 if (*guard != GUARD_BYTE) {
392 ERROR(tdev, "guard byte[%d] %d (not %d)\n",
393 i, *guard, GUARD_BYTE);
394 return -EINVAL;
395 }
396 }
397 return 0;
398}
399
400static int simple_check_buf(struct usbtest_dev *tdev, struct urb *urb)
401{
402 unsigned i;
403 u8 expected;
404 u8 *buf = urb->transfer_buffer;
405 unsigned len = urb->actual_length;
406 unsigned maxpacket = get_maxpacket(urb->dev, urb->pipe);
407
408 int ret = check_guard_bytes(tdev, urb);
409 if (ret)
410 return ret;
411
412 for (i = 0; i < len; i++, buf++) {
413 switch (pattern) {
414 /* all-zeroes has no synchronization issues */
415 case 0:
416 expected = 0;
417 break;
418 /* mod63 stays in sync with short-terminated transfers,
419 * or otherwise when host and gadget agree on how large
420 * each usb transfer request should be. resync is done
421 * with set_interface or set_config.
422 */
423 case 1: /* mod63 */
424 expected = (i % maxpacket) % 63;
425 break;
426 /* always fail unsupported patterns */
427 default:
428 expected = !*buf;
429 break;
430 }
431 if (*buf == expected)
432 continue;
433 ERROR(tdev, "buf[%d] = %d (not %d)\n", i, *buf, expected);
434 return -EINVAL;
435 }
436 return 0;
437}
438
439static void simple_free_urb(struct urb *urb)
440{
441 unsigned long offset = buffer_offset(urb->transfer_buffer);
442
443 if (urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
444 usb_free_coherent(
445 urb->dev,
446 urb->transfer_buffer_length + offset,
447 urb->transfer_buffer - offset,
448 urb->transfer_dma - offset);
449 else
450 kfree(urb->transfer_buffer - offset);
451 usb_free_urb(urb);
452}
453
454static int simple_io(
455 struct usbtest_dev *tdev,
456 struct urb *urb,
457 int iterations,
458 int vary,
459 int expected,
460 const char *label
461)
462{
463 struct usb_device *udev = urb->dev;
464 int max = urb->transfer_buffer_length;
465 struct completion completion;
466 int retval = 0;
467 unsigned long expire;
468
469 urb->context = &completion;
470 while (retval == 0 && iterations-- > 0) {
471 init_completion(&completion);
472 if (usb_pipeout(urb->pipe)) {
473 simple_fill_buf(urb);
474 urb->transfer_flags |= URB_ZERO_PACKET;
475 }
476 retval = usb_submit_urb(urb, GFP_KERNEL);
477 if (retval != 0)
478 break;
479
480 expire = msecs_to_jiffies(SIMPLE_IO_TIMEOUT);
481 if (!wait_for_completion_timeout(&completion, expire)) {
482 usb_kill_urb(urb);
483 retval = (urb->status == -ENOENT ?
484 -ETIMEDOUT : urb->status);
485 } else {
486 retval = urb->status;
487 }
488
489 urb->dev = udev;
490 if (retval == 0 && usb_pipein(urb->pipe))
491 retval = simple_check_buf(tdev, urb);
492
493 if (vary) {
494 int len = urb->transfer_buffer_length;
495
496 len += vary;
497 len %= max;
498 if (len == 0)
499 len = (vary < max) ? vary : max;
500 urb->transfer_buffer_length = len;
501 }
502
503 /* FIXME if endpoint halted, clear halt (and log) */
504 }
505 urb->transfer_buffer_length = max;
506
507 if (expected != retval)
508 dev_err(&udev->dev,
509 "%s failed, iterations left %d, status %d (not %d)\n",
510 label, iterations, retval, expected);
511 return retval;
512}
513
514
515/*-------------------------------------------------------------------------*/
516
517/* We use scatterlist primitives to test queued I/O.
518 * Yes, this also tests the scatterlist primitives.
519 */
520
521static void free_sglist(struct scatterlist *sg, int nents)
522{
523 unsigned i;
524
525 if (!sg)
526 return;
527 for (i = 0; i < nents; i++) {
528 if (!sg_page(&sg[i]))
529 continue;
530 kfree(sg_virt(&sg[i]));
531 }
532 kfree(sg);
533}
534
535static struct scatterlist *
536alloc_sglist(int nents, int max, int vary, struct usbtest_dev *dev, int pipe)
537{
538 struct scatterlist *sg;
539 unsigned int n_size = 0;
540 unsigned i;
541 unsigned size = max;
542 unsigned maxpacket =
543 get_maxpacket(interface_to_usbdev(dev->intf), pipe);
544
545 if (max == 0)
546 return NULL;
547
548 sg = kmalloc_array(nents, sizeof(*sg), GFP_KERNEL);
549 if (!sg)
550 return NULL;
551 sg_init_table(sg, nents);
552
553 for (i = 0; i < nents; i++) {
554 char *buf;
555 unsigned j;
556
557 buf = kzalloc(size, GFP_KERNEL);
558 if (!buf) {
559 free_sglist(sg, i);
560 return NULL;
561 }
562
563 /* kmalloc pages are always physically contiguous! */
564 sg_set_buf(&sg[i], buf, size);
565
566 switch (pattern) {
567 case 0:
568 /* already zeroed */
569 break;
570 case 1:
571 for (j = 0; j < size; j++)
572 *buf++ = (u8) (((j + n_size) % maxpacket) % 63);
573 n_size += size;
574 break;
575 }
576
577 if (vary) {
578 size += vary;
579 size %= max;
580 if (size == 0)
581 size = (vary < max) ? vary : max;
582 }
583 }
584
585 return sg;
586}
587
588struct sg_timeout {
589 struct timer_list timer;
590 struct usb_sg_request *req;
591};
592
593static void sg_timeout(struct timer_list *t)
594{
595 struct sg_timeout *timeout = from_timer(timeout, t, timer);
596
597 usb_sg_cancel(timeout->req);
598}
599
600static int perform_sglist(
601 struct usbtest_dev *tdev,
602 unsigned iterations,
603 int pipe,
604 struct usb_sg_request *req,
605 struct scatterlist *sg,
606 int nents
607)
608{
609 struct usb_device *udev = testdev_to_usbdev(tdev);
610 int retval = 0;
611 struct sg_timeout timeout = {
612 .req = req,
613 };
614
615 timer_setup_on_stack(&timeout.timer, sg_timeout, 0);
616
617 while (retval == 0 && iterations-- > 0) {
618 retval = usb_sg_init(req, udev, pipe,
619 (udev->speed == USB_SPEED_HIGH)
620 ? (INTERRUPT_RATE << 3)
621 : INTERRUPT_RATE,
622 sg, nents, 0, GFP_KERNEL);
623
624 if (retval)
625 break;
626 mod_timer(&timeout.timer, jiffies +
627 msecs_to_jiffies(SIMPLE_IO_TIMEOUT));
628 usb_sg_wait(req);
629 if (!del_timer_sync(&timeout.timer))
630 retval = -ETIMEDOUT;
631 else
632 retval = req->status;
633 destroy_timer_on_stack(&timeout.timer);
634
635 /* FIXME check resulting data pattern */
636
637 /* FIXME if endpoint halted, clear halt (and log) */
638 }
639
640 /* FIXME for unlink or fault handling tests, don't report
641 * failure if retval is as we expected ...
642 */
643 if (retval)
644 ERROR(tdev, "perform_sglist failed, "
645 "iterations left %d, status %d\n",
646 iterations, retval);
647 return retval;
648}
649
650
651/*-------------------------------------------------------------------------*/
652
653/* unqueued control message testing
654 *
655 * there's a nice set of device functional requirements in chapter 9 of the
656 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
657 * special test firmware.
658 *
659 * we know the device is configured (or suspended) by the time it's visible
660 * through usbfs. we can't change that, so we won't test enumeration (which
661 * worked 'well enough' to get here, this time), power management (ditto),
662 * or remote wakeup (which needs human interaction).
663 */
664
665static unsigned realworld = 1;
666module_param(realworld, uint, 0);
667MODULE_PARM_DESC(realworld, "clear to demand stricter spec compliance");
668
669static int get_altsetting(struct usbtest_dev *dev)
670{
671 struct usb_interface *iface = dev->intf;
672 struct usb_device *udev = interface_to_usbdev(iface);
673 int retval;
674
675 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
676 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
677 0, iface->altsetting[0].desc.bInterfaceNumber,
678 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
679 switch (retval) {
680 case 1:
681 return dev->buf[0];
682 case 0:
683 retval = -ERANGE;
684 fallthrough;
685 default:
686 return retval;
687 }
688}
689
690static int set_altsetting(struct usbtest_dev *dev, int alternate)
691{
692 struct usb_interface *iface = dev->intf;
693 struct usb_device *udev;
694
695 if (alternate < 0 || alternate >= 256)
696 return -EINVAL;
697
698 udev = interface_to_usbdev(iface);
699 return usb_set_interface(udev,
700 iface->altsetting[0].desc.bInterfaceNumber,
701 alternate);
702}
703
704static int is_good_config(struct usbtest_dev *tdev, int len)
705{
706 struct usb_config_descriptor *config;
707
708 if (len < sizeof(*config))
709 return 0;
710 config = (struct usb_config_descriptor *) tdev->buf;
711
712 switch (config->bDescriptorType) {
713 case USB_DT_CONFIG:
714 case USB_DT_OTHER_SPEED_CONFIG:
715 if (config->bLength != 9) {
716 ERROR(tdev, "bogus config descriptor length\n");
717 return 0;
718 }
719 /* this bit 'must be 1' but often isn't */
720 if (!realworld && !(config->bmAttributes & 0x80)) {
721 ERROR(tdev, "high bit of config attributes not set\n");
722 return 0;
723 }
724 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
725 ERROR(tdev, "reserved config bits set\n");
726 return 0;
727 }
728 break;
729 default:
730 return 0;
731 }
732
733 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
734 return 1;
735 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
736 return 1;
737 ERROR(tdev, "bogus config descriptor read size\n");
738 return 0;
739}
740
741static int is_good_ext(struct usbtest_dev *tdev, u8 *buf)
742{
743 struct usb_ext_cap_descriptor *ext;
744 u32 attr;
745
746 ext = (struct usb_ext_cap_descriptor *) buf;
747
748 if (ext->bLength != USB_DT_USB_EXT_CAP_SIZE) {
749 ERROR(tdev, "bogus usb 2.0 extension descriptor length\n");
750 return 0;
751 }
752
753 attr = le32_to_cpu(ext->bmAttributes);
754 /* bits[1:15] is used and others are reserved */
755 if (attr & ~0xfffe) { /* reserved == 0 */
756 ERROR(tdev, "reserved bits set\n");
757 return 0;
758 }
759
760 return 1;
761}
762
763static int is_good_ss_cap(struct usbtest_dev *tdev, u8 *buf)
764{
765 struct usb_ss_cap_descriptor *ss;
766
767 ss = (struct usb_ss_cap_descriptor *) buf;
768
769 if (ss->bLength != USB_DT_USB_SS_CAP_SIZE) {
770 ERROR(tdev, "bogus superspeed device capability descriptor length\n");
771 return 0;
772 }
773
774 /*
775 * only bit[1] of bmAttributes is used for LTM and others are
776 * reserved
777 */
778 if (ss->bmAttributes & ~0x02) { /* reserved == 0 */
779 ERROR(tdev, "reserved bits set in bmAttributes\n");
780 return 0;
781 }
782
783 /* bits[0:3] of wSpeedSupported is used and others are reserved */
784 if (le16_to_cpu(ss->wSpeedSupported) & ~0x0f) { /* reserved == 0 */
785 ERROR(tdev, "reserved bits set in wSpeedSupported\n");
786 return 0;
787 }
788
789 return 1;
790}
791
792static int is_good_con_id(struct usbtest_dev *tdev, u8 *buf)
793{
794 struct usb_ss_container_id_descriptor *con_id;
795
796 con_id = (struct usb_ss_container_id_descriptor *) buf;
797
798 if (con_id->bLength != USB_DT_USB_SS_CONTN_ID_SIZE) {
799 ERROR(tdev, "bogus container id descriptor length\n");
800 return 0;
801 }
802
803 if (con_id->bReserved) { /* reserved == 0 */
804 ERROR(tdev, "reserved bits set\n");
805 return 0;
806 }
807
808 return 1;
809}
810
811/* sanity test for standard requests working with usb_control_mesg() and some
812 * of the utility functions which use it.
813 *
814 * this doesn't test how endpoint halts behave or data toggles get set, since
815 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
816 * halt or toggle). toggle testing is impractical without support from hcds.
817 *
818 * this avoids failing devices linux would normally work with, by not testing
819 * config/altsetting operations for devices that only support their defaults.
820 * such devices rarely support those needless operations.
821 *
822 * NOTE that since this is a sanity test, it's not examining boundary cases
823 * to see if usbcore, hcd, and device all behave right. such testing would
824 * involve varied read sizes and other operation sequences.
825 */
826static int ch9_postconfig(struct usbtest_dev *dev)
827{
828 struct usb_interface *iface = dev->intf;
829 struct usb_device *udev = interface_to_usbdev(iface);
830 int i, alt, retval;
831
832 /* [9.2.3] if there's more than one altsetting, we need to be able to
833 * set and get each one. mostly trusts the descriptors from usbcore.
834 */
835 for (i = 0; i < iface->num_altsetting; i++) {
836
837 /* 9.2.3 constrains the range here */
838 alt = iface->altsetting[i].desc.bAlternateSetting;
839 if (alt < 0 || alt >= iface->num_altsetting) {
840 dev_err(&iface->dev,
841 "invalid alt [%d].bAltSetting = %d\n",
842 i, alt);
843 }
844
845 /* [real world] get/set unimplemented if there's only one */
846 if (realworld && iface->num_altsetting == 1)
847 continue;
848
849 /* [9.4.10] set_interface */
850 retval = set_altsetting(dev, alt);
851 if (retval) {
852 dev_err(&iface->dev, "can't set_interface = %d, %d\n",
853 alt, retval);
854 return retval;
855 }
856
857 /* [9.4.4] get_interface always works */
858 retval = get_altsetting(dev);
859 if (retval != alt) {
860 dev_err(&iface->dev, "get alt should be %d, was %d\n",
861 alt, retval);
862 return (retval < 0) ? retval : -EDOM;
863 }
864
865 }
866
867 /* [real world] get_config unimplemented if there's only one */
868 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
869 int expected = udev->actconfig->desc.bConfigurationValue;
870
871 /* [9.4.2] get_configuration always works
872 * ... although some cheap devices (like one TI Hub I've got)
873 * won't return config descriptors except before set_config.
874 */
875 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
876 USB_REQ_GET_CONFIGURATION,
877 USB_DIR_IN | USB_RECIP_DEVICE,
878 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
879 if (retval != 1 || dev->buf[0] != expected) {
880 dev_err(&iface->dev, "get config --> %d %d (1 %d)\n",
881 retval, dev->buf[0], expected);
882 return (retval < 0) ? retval : -EDOM;
883 }
884 }
885
886 /* there's always [9.4.3] a device descriptor [9.6.1] */
887 retval = usb_get_descriptor(udev, USB_DT_DEVICE, 0,
888 dev->buf, sizeof(udev->descriptor));
889 if (retval != sizeof(udev->descriptor)) {
890 dev_err(&iface->dev, "dev descriptor --> %d\n", retval);
891 return (retval < 0) ? retval : -EDOM;
892 }
893
894 /*
895 * there's always [9.4.3] a bos device descriptor [9.6.2] in USB
896 * 3.0 spec
897 */
898 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0210) {
899 struct usb_bos_descriptor *bos = NULL;
900 struct usb_dev_cap_header *header = NULL;
901 unsigned total, num, length;
902 u8 *buf;
903
904 retval = usb_get_descriptor(udev, USB_DT_BOS, 0, dev->buf,
905 sizeof(*udev->bos->desc));
906 if (retval != sizeof(*udev->bos->desc)) {
907 dev_err(&iface->dev, "bos descriptor --> %d\n", retval);
908 return (retval < 0) ? retval : -EDOM;
909 }
910
911 bos = (struct usb_bos_descriptor *)dev->buf;
912 total = le16_to_cpu(bos->wTotalLength);
913 num = bos->bNumDeviceCaps;
914
915 if (total > TBUF_SIZE)
916 total = TBUF_SIZE;
917
918 /*
919 * get generic device-level capability descriptors [9.6.2]
920 * in USB 3.0 spec
921 */
922 retval = usb_get_descriptor(udev, USB_DT_BOS, 0, dev->buf,
923 total);
924 if (retval != total) {
925 dev_err(&iface->dev, "bos descriptor set --> %d\n",
926 retval);
927 return (retval < 0) ? retval : -EDOM;
928 }
929
930 length = sizeof(*udev->bos->desc);
931 buf = dev->buf;
932 for (i = 0; i < num; i++) {
933 buf += length;
934 if (buf + sizeof(struct usb_dev_cap_header) >
935 dev->buf + total)
936 break;
937
938 header = (struct usb_dev_cap_header *)buf;
939 length = header->bLength;
940
941 if (header->bDescriptorType !=
942 USB_DT_DEVICE_CAPABILITY) {
943 dev_warn(&udev->dev, "not device capability descriptor, skip\n");
944 continue;
945 }
946
947 switch (header->bDevCapabilityType) {
948 case USB_CAP_TYPE_EXT:
949 if (buf + USB_DT_USB_EXT_CAP_SIZE >
950 dev->buf + total ||
951 !is_good_ext(dev, buf)) {
952 dev_err(&iface->dev, "bogus usb 2.0 extension descriptor\n");
953 return -EDOM;
954 }
955 break;
956 case USB_SS_CAP_TYPE:
957 if (buf + USB_DT_USB_SS_CAP_SIZE >
958 dev->buf + total ||
959 !is_good_ss_cap(dev, buf)) {
960 dev_err(&iface->dev, "bogus superspeed device capability descriptor\n");
961 return -EDOM;
962 }
963 break;
964 case CONTAINER_ID_TYPE:
965 if (buf + USB_DT_USB_SS_CONTN_ID_SIZE >
966 dev->buf + total ||
967 !is_good_con_id(dev, buf)) {
968 dev_err(&iface->dev, "bogus container id descriptor\n");
969 return -EDOM;
970 }
971 break;
972 default:
973 break;
974 }
975 }
976 }
977
978 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
979 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
980 retval = usb_get_descriptor(udev, USB_DT_CONFIG, i,
981 dev->buf, TBUF_SIZE);
982 if (!is_good_config(dev, retval)) {
983 dev_err(&iface->dev,
984 "config [%d] descriptor --> %d\n",
985 i, retval);
986 return (retval < 0) ? retval : -EDOM;
987 }
988
989 /* FIXME cross-checking udev->config[i] to make sure usbcore
990 * parsed it right (etc) would be good testing paranoia
991 */
992 }
993
994 /* and sometimes [9.2.6.6] speed dependent descriptors */
995 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
996 struct usb_qualifier_descriptor *d = NULL;
997
998 /* device qualifier [9.6.2] */
999 retval = usb_get_descriptor(udev,
1000 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
1001 sizeof(struct usb_qualifier_descriptor));
1002 if (retval == -EPIPE) {
1003 if (udev->speed == USB_SPEED_HIGH) {
1004 dev_err(&iface->dev,
1005 "hs dev qualifier --> %d\n",
1006 retval);
1007 return retval;
1008 }
1009 /* usb2.0 but not high-speed capable; fine */
1010 } else if (retval != sizeof(struct usb_qualifier_descriptor)) {
1011 dev_err(&iface->dev, "dev qualifier --> %d\n", retval);
1012 return (retval < 0) ? retval : -EDOM;
1013 } else
1014 d = (struct usb_qualifier_descriptor *) dev->buf;
1015
1016 /* might not have [9.6.2] any other-speed configs [9.6.4] */
1017 if (d) {
1018 unsigned max = d->bNumConfigurations;
1019 for (i = 0; i < max; i++) {
1020 retval = usb_get_descriptor(udev,
1021 USB_DT_OTHER_SPEED_CONFIG, i,
1022 dev->buf, TBUF_SIZE);
1023 if (!is_good_config(dev, retval)) {
1024 dev_err(&iface->dev,
1025 "other speed config --> %d\n",
1026 retval);
1027 return (retval < 0) ? retval : -EDOM;
1028 }
1029 }
1030 }
1031 }
1032 /* FIXME fetch strings from at least the device descriptor */
1033
1034 /* [9.4.5] get_status always works */
1035 retval = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, dev->buf);
1036 if (retval) {
1037 dev_err(&iface->dev, "get dev status --> %d\n", retval);
1038 return retval;
1039 }
1040
1041 /* FIXME configuration.bmAttributes says if we could try to set/clear
1042 * the device's remote wakeup feature ... if we can, test that here
1043 */
1044
1045 retval = usb_get_std_status(udev, USB_RECIP_INTERFACE,
1046 iface->altsetting[0].desc.bInterfaceNumber, dev->buf);
1047 if (retval) {
1048 dev_err(&iface->dev, "get interface status --> %d\n", retval);
1049 return retval;
1050 }
1051 /* FIXME get status for each endpoint in the interface */
1052
1053 return 0;
1054}
1055
1056/*-------------------------------------------------------------------------*/
1057
1058/* use ch9 requests to test whether:
1059 * (a) queues work for control, keeping N subtests queued and
1060 * active (auto-resubmit) for M loops through the queue.
1061 * (b) protocol stalls (control-only) will autorecover.
1062 * it's not like bulk/intr; no halt clearing.
1063 * (c) short control reads are reported and handled.
1064 * (d) queues are always processed in-order
1065 */
1066
1067struct ctrl_ctx {
1068 spinlock_t lock;
1069 struct usbtest_dev *dev;
1070 struct completion complete;
1071 unsigned count;
1072 unsigned pending;
1073 int status;
1074 struct urb **urb;
1075 struct usbtest_param_32 *param;
1076 int last;
1077};
1078
1079#define NUM_SUBCASES 16 /* how many test subcases here? */
1080
1081struct subcase {
1082 struct usb_ctrlrequest setup;
1083 int number;
1084 int expected;
1085};
1086
1087static void ctrl_complete(struct urb *urb)
1088{
1089 struct ctrl_ctx *ctx = urb->context;
1090 struct usb_ctrlrequest *reqp;
1091 struct subcase *subcase;
1092 int status = urb->status;
1093 unsigned long flags;
1094
1095 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
1096 subcase = container_of(reqp, struct subcase, setup);
1097
1098 spin_lock_irqsave(&ctx->lock, flags);
1099 ctx->count--;
1100 ctx->pending--;
1101
1102 /* queue must transfer and complete in fifo order, unless
1103 * usb_unlink_urb() is used to unlink something not at the
1104 * physical queue head (not tested).
1105 */
1106 if (subcase->number > 0) {
1107 if ((subcase->number - ctx->last) != 1) {
1108 ERROR(ctx->dev,
1109 "subcase %d completed out of order, last %d\n",
1110 subcase->number, ctx->last);
1111 status = -EDOM;
1112 ctx->last = subcase->number;
1113 goto error;
1114 }
1115 }
1116 ctx->last = subcase->number;
1117
1118 /* succeed or fault in only one way? */
1119 if (status == subcase->expected)
1120 status = 0;
1121
1122 /* async unlink for cleanup? */
1123 else if (status != -ECONNRESET) {
1124
1125 /* some faults are allowed, not required */
1126 if (subcase->expected > 0 && (
1127 ((status == -subcase->expected /* happened */
1128 || status == 0)))) /* didn't */
1129 status = 0;
1130 /* sometimes more than one fault is allowed */
1131 else if (subcase->number == 12 && status == -EPIPE)
1132 status = 0;
1133 else
1134 ERROR(ctx->dev, "subtest %d error, status %d\n",
1135 subcase->number, status);
1136 }
1137
1138 /* unexpected status codes mean errors; ideally, in hardware */
1139 if (status) {
1140error:
1141 if (ctx->status == 0) {
1142 int i;
1143
1144 ctx->status = status;
1145 ERROR(ctx->dev, "control queue %02x.%02x, err %d, "
1146 "%d left, subcase %d, len %d/%d\n",
1147 reqp->bRequestType, reqp->bRequest,
1148 status, ctx->count, subcase->number,
1149 urb->actual_length,
1150 urb->transfer_buffer_length);
1151
1152 /* FIXME this "unlink everything" exit route should
1153 * be a separate test case.
1154 */
1155
1156 /* unlink whatever's still pending */
1157 for (i = 1; i < ctx->param->sglen; i++) {
1158 struct urb *u = ctx->urb[
1159 (i + subcase->number)
1160 % ctx->param->sglen];
1161
1162 if (u == urb || !u->dev)
1163 continue;
1164 spin_unlock(&ctx->lock);
1165 status = usb_unlink_urb(u);
1166 spin_lock(&ctx->lock);
1167 switch (status) {
1168 case -EINPROGRESS:
1169 case -EBUSY:
1170 case -EIDRM:
1171 continue;
1172 default:
1173 ERROR(ctx->dev, "urb unlink --> %d\n",
1174 status);
1175 }
1176 }
1177 status = ctx->status;
1178 }
1179 }
1180
1181 /* resubmit if we need to, else mark this as done */
1182 if ((status == 0) && (ctx->pending < ctx->count)) {
1183 status = usb_submit_urb(urb, GFP_ATOMIC);
1184 if (status != 0) {
1185 ERROR(ctx->dev,
1186 "can't resubmit ctrl %02x.%02x, err %d\n",
1187 reqp->bRequestType, reqp->bRequest, status);
1188 urb->dev = NULL;
1189 } else
1190 ctx->pending++;
1191 } else
1192 urb->dev = NULL;
1193
1194 /* signal completion when nothing's queued */
1195 if (ctx->pending == 0)
1196 complete(&ctx->complete);
1197 spin_unlock_irqrestore(&ctx->lock, flags);
1198}
1199
1200static int
1201test_ctrl_queue(struct usbtest_dev *dev, struct usbtest_param_32 *param)
1202{
1203 struct usb_device *udev = testdev_to_usbdev(dev);
1204 struct urb **urb;
1205 struct ctrl_ctx context;
1206 int i;
1207
1208 if (param->sglen == 0 || param->iterations > UINT_MAX / param->sglen)
1209 return -EOPNOTSUPP;
1210
1211 spin_lock_init(&context.lock);
1212 context.dev = dev;
1213 init_completion(&context.complete);
1214 context.count = param->sglen * param->iterations;
1215 context.pending = 0;
1216 context.status = -ENOMEM;
1217 context.param = param;
1218 context.last = -1;
1219
1220 /* allocate and init the urbs we'll queue.
1221 * as with bulk/intr sglists, sglen is the queue depth; it also
1222 * controls which subtests run (more tests than sglen) or rerun.
1223 */
1224 urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
1225 if (!urb)
1226 return -ENOMEM;
1227 for (i = 0; i < param->sglen; i++) {
1228 int pipe = usb_rcvctrlpipe(udev, 0);
1229 unsigned len;
1230 struct urb *u;
1231 struct usb_ctrlrequest req;
1232 struct subcase *reqp;
1233
1234 /* sign of this variable means:
1235 * -: tested code must return this (negative) error code
1236 * +: tested code may return this (negative too) error code
1237 */
1238 int expected = 0;
1239
1240 /* requests here are mostly expected to succeed on any
1241 * device, but some are chosen to trigger protocol stalls
1242 * or short reads.
1243 */
1244 memset(&req, 0, sizeof(req));
1245 req.bRequest = USB_REQ_GET_DESCRIPTOR;
1246 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
1247
1248 switch (i % NUM_SUBCASES) {
1249 case 0: /* get device descriptor */
1250 req.wValue = cpu_to_le16(USB_DT_DEVICE << 8);
1251 len = sizeof(struct usb_device_descriptor);
1252 break;
1253 case 1: /* get first config descriptor (only) */
1254 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1255 len = sizeof(struct usb_config_descriptor);
1256 break;
1257 case 2: /* get altsetting (OFTEN STALLS) */
1258 req.bRequest = USB_REQ_GET_INTERFACE;
1259 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
1260 /* index = 0 means first interface */
1261 len = 1;
1262 expected = EPIPE;
1263 break;
1264 case 3: /* get interface status */
1265 req.bRequest = USB_REQ_GET_STATUS;
1266 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
1267 /* interface 0 */
1268 len = 2;
1269 break;
1270 case 4: /* get device status */
1271 req.bRequest = USB_REQ_GET_STATUS;
1272 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
1273 len = 2;
1274 break;
1275 case 5: /* get device qualifier (MAY STALL) */
1276 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
1277 len = sizeof(struct usb_qualifier_descriptor);
1278 if (udev->speed != USB_SPEED_HIGH)
1279 expected = EPIPE;
1280 break;
1281 case 6: /* get first config descriptor, plus interface */
1282 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1283 len = sizeof(struct usb_config_descriptor);
1284 len += sizeof(struct usb_interface_descriptor);
1285 break;
1286 case 7: /* get interface descriptor (ALWAYS STALLS) */
1287 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
1288 /* interface == 0 */
1289 len = sizeof(struct usb_interface_descriptor);
1290 expected = -EPIPE;
1291 break;
1292 /* NOTE: two consecutive stalls in the queue here.
1293 * that tests fault recovery a bit more aggressively. */
1294 case 8: /* clear endpoint halt (MAY STALL) */
1295 req.bRequest = USB_REQ_CLEAR_FEATURE;
1296 req.bRequestType = USB_RECIP_ENDPOINT;
1297 /* wValue 0 == ep halt */
1298 /* wIndex 0 == ep0 (shouldn't halt!) */
1299 len = 0;
1300 pipe = usb_sndctrlpipe(udev, 0);
1301 expected = EPIPE;
1302 break;
1303 case 9: /* get endpoint status */
1304 req.bRequest = USB_REQ_GET_STATUS;
1305 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
1306 /* endpoint 0 */
1307 len = 2;
1308 break;
1309 case 10: /* trigger short read (EREMOTEIO) */
1310 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1311 len = 1024;
1312 expected = -EREMOTEIO;
1313 break;
1314 /* NOTE: two consecutive _different_ faults in the queue. */
1315 case 11: /* get endpoint descriptor (ALWAYS STALLS) */
1316 req.wValue = cpu_to_le16(USB_DT_ENDPOINT << 8);
1317 /* endpoint == 0 */
1318 len = sizeof(struct usb_interface_descriptor);
1319 expected = EPIPE;
1320 break;
1321 /* NOTE: sometimes even a third fault in the queue! */
1322 case 12: /* get string 0 descriptor (MAY STALL) */
1323 req.wValue = cpu_to_le16(USB_DT_STRING << 8);
1324 /* string == 0, for language IDs */
1325 len = sizeof(struct usb_interface_descriptor);
1326 /* may succeed when > 4 languages */
1327 expected = EREMOTEIO; /* or EPIPE, if no strings */
1328 break;
1329 case 13: /* short read, resembling case 10 */
1330 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1331 /* last data packet "should" be DATA1, not DATA0 */
1332 if (udev->speed == USB_SPEED_SUPER)
1333 len = 1024 - 512;
1334 else
1335 len = 1024 - udev->descriptor.bMaxPacketSize0;
1336 expected = -EREMOTEIO;
1337 break;
1338 case 14: /* short read; try to fill the last packet */
1339 req.wValue = cpu_to_le16((USB_DT_DEVICE << 8) | 0);
1340 /* device descriptor size == 18 bytes */
1341 len = udev->descriptor.bMaxPacketSize0;
1342 if (udev->speed == USB_SPEED_SUPER)
1343 len = 512;
1344 switch (len) {
1345 case 8:
1346 len = 24;
1347 break;
1348 case 16:
1349 len = 32;
1350 break;
1351 }
1352 expected = -EREMOTEIO;
1353 break;
1354 case 15:
1355 req.wValue = cpu_to_le16(USB_DT_BOS << 8);
1356 if (udev->bos)
1357 len = le16_to_cpu(udev->bos->desc->wTotalLength);
1358 else
1359 len = sizeof(struct usb_bos_descriptor);
1360 if (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0201)
1361 expected = -EPIPE;
1362 break;
1363 default:
1364 ERROR(dev, "bogus number of ctrl queue testcases!\n");
1365 context.status = -EINVAL;
1366 goto cleanup;
1367 }
1368 req.wLength = cpu_to_le16(len);
1369 urb[i] = u = simple_alloc_urb(udev, pipe, len, 0);
1370 if (!u)
1371 goto cleanup;
1372
1373 reqp = kmalloc(sizeof(*reqp), GFP_KERNEL);
1374 if (!reqp)
1375 goto cleanup;
1376 reqp->setup = req;
1377 reqp->number = i % NUM_SUBCASES;
1378 reqp->expected = expected;
1379 u->setup_packet = (char *) &reqp->setup;
1380
1381 u->context = &context;
1382 u->complete = ctrl_complete;
1383 }
1384
1385 /* queue the urbs */
1386 context.urb = urb;
1387 spin_lock_irq(&context.lock);
1388 for (i = 0; i < param->sglen; i++) {
1389 context.status = usb_submit_urb(urb[i], GFP_ATOMIC);
1390 if (context.status != 0) {
1391 ERROR(dev, "can't submit urb[%d], status %d\n",
1392 i, context.status);
1393 context.count = context.pending;
1394 break;
1395 }
1396 context.pending++;
1397 }
1398 spin_unlock_irq(&context.lock);
1399
1400 /* FIXME set timer and time out; provide a disconnect hook */
1401
1402 /* wait for the last one to complete */
1403 if (context.pending > 0)
1404 wait_for_completion(&context.complete);
1405
1406cleanup:
1407 for (i = 0; i < param->sglen; i++) {
1408 if (!urb[i])
1409 continue;
1410 urb[i]->dev = udev;
1411 kfree(urb[i]->setup_packet);
1412 simple_free_urb(urb[i]);
1413 }
1414 kfree(urb);
1415 return context.status;
1416}
1417#undef NUM_SUBCASES
1418
1419
1420/*-------------------------------------------------------------------------*/
1421
1422static void unlink1_callback(struct urb *urb)
1423{
1424 int status = urb->status;
1425
1426 /* we "know" -EPIPE (stall) never happens */
1427 if (!status)
1428 status = usb_submit_urb(urb, GFP_ATOMIC);
1429 if (status) {
1430 urb->status = status;
1431 complete(urb->context);
1432 }
1433}
1434
1435static int unlink1(struct usbtest_dev *dev, int pipe, int size, int async)
1436{
1437 struct urb *urb;
1438 struct completion completion;
1439 int retval = 0;
1440
1441 init_completion(&completion);
1442 urb = simple_alloc_urb(testdev_to_usbdev(dev), pipe, size, 0);
1443 if (!urb)
1444 return -ENOMEM;
1445 urb->context = &completion;
1446 urb->complete = unlink1_callback;
1447
1448 if (usb_pipeout(urb->pipe)) {
1449 simple_fill_buf(urb);
1450 urb->transfer_flags |= URB_ZERO_PACKET;
1451 }
1452
1453 /* keep the endpoint busy. there are lots of hc/hcd-internal
1454 * states, and testing should get to all of them over time.
1455 *
1456 * FIXME want additional tests for when endpoint is STALLing
1457 * due to errors, or is just NAKing requests.
1458 */
1459 retval = usb_submit_urb(urb, GFP_KERNEL);
1460 if (retval != 0) {
1461 dev_err(&dev->intf->dev, "submit fail %d\n", retval);
1462 return retval;
1463 }
1464
1465 /* unlinking that should always work. variable delay tests more
1466 * hcd states and code paths, even with little other system load.
1467 */
1468 msleep(jiffies % (2 * INTERRUPT_RATE));
1469 if (async) {
1470 while (!completion_done(&completion)) {
1471 retval = usb_unlink_urb(urb);
1472
1473 if (retval == 0 && usb_pipein(urb->pipe))
1474 retval = simple_check_buf(dev, urb);
1475
1476 switch (retval) {
1477 case -EBUSY:
1478 case -EIDRM:
1479 /* we can't unlink urbs while they're completing
1480 * or if they've completed, and we haven't
1481 * resubmitted. "normal" drivers would prevent
1482 * resubmission, but since we're testing unlink
1483 * paths, we can't.
1484 */
1485 ERROR(dev, "unlink retry\n");
1486 continue;
1487 case 0:
1488 case -EINPROGRESS:
1489 break;
1490
1491 default:
1492 dev_err(&dev->intf->dev,
1493 "unlink fail %d\n", retval);
1494 return retval;
1495 }
1496
1497 break;
1498 }
1499 } else
1500 usb_kill_urb(urb);
1501
1502 wait_for_completion(&completion);
1503 retval = urb->status;
1504 simple_free_urb(urb);
1505
1506 if (async)
1507 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1508 else
1509 return (retval == -ENOENT || retval == -EPERM) ?
1510 0 : retval - 2000;
1511}
1512
1513static int unlink_simple(struct usbtest_dev *dev, int pipe, int len)
1514{
1515 int retval = 0;
1516
1517 /* test sync and async paths */
1518 retval = unlink1(dev, pipe, len, 1);
1519 if (!retval)
1520 retval = unlink1(dev, pipe, len, 0);
1521 return retval;
1522}
1523
1524/*-------------------------------------------------------------------------*/
1525
1526struct queued_ctx {
1527 struct completion complete;
1528 atomic_t pending;
1529 unsigned num;
1530 int status;
1531 struct urb **urbs;
1532};
1533
1534static void unlink_queued_callback(struct urb *urb)
1535{
1536 int status = urb->status;
1537 struct queued_ctx *ctx = urb->context;
1538
1539 if (ctx->status)
1540 goto done;
1541 if (urb == ctx->urbs[ctx->num - 4] || urb == ctx->urbs[ctx->num - 2]) {
1542 if (status == -ECONNRESET)
1543 goto done;
1544 /* What error should we report if the URB completed normally? */
1545 }
1546 if (status != 0)
1547 ctx->status = status;
1548
1549 done:
1550 if (atomic_dec_and_test(&ctx->pending))
1551 complete(&ctx->complete);
1552}
1553
1554static int unlink_queued(struct usbtest_dev *dev, int pipe, unsigned num,
1555 unsigned size)
1556{
1557 struct queued_ctx ctx;
1558 struct usb_device *udev = testdev_to_usbdev(dev);
1559 void *buf;
1560 dma_addr_t buf_dma;
1561 int i;
1562 int retval = -ENOMEM;
1563
1564 init_completion(&ctx.complete);
1565 atomic_set(&ctx.pending, 1); /* One more than the actual value */
1566 ctx.num = num;
1567 ctx.status = 0;
1568
1569 buf = usb_alloc_coherent(udev, size, GFP_KERNEL, &buf_dma);
1570 if (!buf)
1571 return retval;
1572 memset(buf, 0, size);
1573
1574 /* Allocate and init the urbs we'll queue */
1575 ctx.urbs = kcalloc(num, sizeof(struct urb *), GFP_KERNEL);
1576 if (!ctx.urbs)
1577 goto free_buf;
1578 for (i = 0; i < num; i++) {
1579 ctx.urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
1580 if (!ctx.urbs[i])
1581 goto free_urbs;
1582 usb_fill_bulk_urb(ctx.urbs[i], udev, pipe, buf, size,
1583 unlink_queued_callback, &ctx);
1584 ctx.urbs[i]->transfer_dma = buf_dma;
1585 ctx.urbs[i]->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1586
1587 if (usb_pipeout(ctx.urbs[i]->pipe)) {
1588 simple_fill_buf(ctx.urbs[i]);
1589 ctx.urbs[i]->transfer_flags |= URB_ZERO_PACKET;
1590 }
1591 }
1592
1593 /* Submit all the URBs and then unlink URBs num - 4 and num - 2. */
1594 for (i = 0; i < num; i++) {
1595 atomic_inc(&ctx.pending);
1596 retval = usb_submit_urb(ctx.urbs[i], GFP_KERNEL);
1597 if (retval != 0) {
1598 dev_err(&dev->intf->dev, "submit urbs[%d] fail %d\n",
1599 i, retval);
1600 atomic_dec(&ctx.pending);
1601 ctx.status = retval;
1602 break;
1603 }
1604 }
1605 if (i == num) {
1606 usb_unlink_urb(ctx.urbs[num - 4]);
1607 usb_unlink_urb(ctx.urbs[num - 2]);
1608 } else {
1609 while (--i >= 0)
1610 usb_unlink_urb(ctx.urbs[i]);
1611 }
1612
1613 if (atomic_dec_and_test(&ctx.pending)) /* The extra count */
1614 complete(&ctx.complete);
1615 wait_for_completion(&ctx.complete);
1616 retval = ctx.status;
1617
1618 free_urbs:
1619 for (i = 0; i < num; i++)
1620 usb_free_urb(ctx.urbs[i]);
1621 kfree(ctx.urbs);
1622 free_buf:
1623 usb_free_coherent(udev, size, buf, buf_dma);
1624 return retval;
1625}
1626
1627/*-------------------------------------------------------------------------*/
1628
1629static int verify_not_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1630{
1631 int retval;
1632 u16 status;
1633
1634 /* shouldn't look or act halted */
1635 retval = usb_get_std_status(urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1636 if (retval < 0) {
1637 ERROR(tdev, "ep %02x couldn't get no-halt status, %d\n",
1638 ep, retval);
1639 return retval;
1640 }
1641 if (status != 0) {
1642 ERROR(tdev, "ep %02x bogus status: %04x != 0\n", ep, status);
1643 return -EINVAL;
1644 }
1645 retval = simple_io(tdev, urb, 1, 0, 0, __func__);
1646 if (retval != 0)
1647 return -EINVAL;
1648 return 0;
1649}
1650
1651static int verify_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1652{
1653 int retval;
1654 u16 status;
1655
1656 /* should look and act halted */
1657 retval = usb_get_std_status(urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1658 if (retval < 0) {
1659 ERROR(tdev, "ep %02x couldn't get halt status, %d\n",
1660 ep, retval);
1661 return retval;
1662 }
1663 if (status != 1) {
1664 ERROR(tdev, "ep %02x bogus status: %04x != 1\n", ep, status);
1665 return -EINVAL;
1666 }
1667 retval = simple_io(tdev, urb, 1, 0, -EPIPE, __func__);
1668 if (retval != -EPIPE)
1669 return -EINVAL;
1670 retval = simple_io(tdev, urb, 1, 0, -EPIPE, "verify_still_halted");
1671 if (retval != -EPIPE)
1672 return -EINVAL;
1673 return 0;
1674}
1675
1676static int test_halt(struct usbtest_dev *tdev, int ep, struct urb *urb)
1677{
1678 int retval;
1679
1680 /* shouldn't look or act halted now */
1681 retval = verify_not_halted(tdev, ep, urb);
1682 if (retval < 0)
1683 return retval;
1684
1685 /* set halt (protocol test only), verify it worked */
1686 retval = usb_control_msg(urb->dev, usb_sndctrlpipe(urb->dev, 0),
1687 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1688 USB_ENDPOINT_HALT, ep,
1689 NULL, 0, USB_CTRL_SET_TIMEOUT);
1690 if (retval < 0) {
1691 ERROR(tdev, "ep %02x couldn't set halt, %d\n", ep, retval);
1692 return retval;
1693 }
1694 retval = verify_halted(tdev, ep, urb);
1695 if (retval < 0) {
1696 int ret;
1697
1698 /* clear halt anyways, else further tests will fail */
1699 ret = usb_clear_halt(urb->dev, urb->pipe);
1700 if (ret)
1701 ERROR(tdev, "ep %02x couldn't clear halt, %d\n",
1702 ep, ret);
1703
1704 return retval;
1705 }
1706
1707 /* clear halt (tests API + protocol), verify it worked */
1708 retval = usb_clear_halt(urb->dev, urb->pipe);
1709 if (retval < 0) {
1710 ERROR(tdev, "ep %02x couldn't clear halt, %d\n", ep, retval);
1711 return retval;
1712 }
1713 retval = verify_not_halted(tdev, ep, urb);
1714 if (retval < 0)
1715 return retval;
1716
1717 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1718
1719 return 0;
1720}
1721
1722static int test_toggle_sync(struct usbtest_dev *tdev, int ep, struct urb *urb)
1723{
1724 int retval;
1725
1726 /* clear initial data toggle to DATA0 */
1727 retval = usb_clear_halt(urb->dev, urb->pipe);
1728 if (retval < 0) {
1729 ERROR(tdev, "ep %02x couldn't clear halt, %d\n", ep, retval);
1730 return retval;
1731 }
1732
1733 /* transfer 3 data packets, should be DATA0, DATA1, DATA0 */
1734 retval = simple_io(tdev, urb, 1, 0, 0, __func__);
1735 if (retval != 0)
1736 return -EINVAL;
1737
1738 /* clear halt resets device side data toggle, host should react to it */
1739 retval = usb_clear_halt(urb->dev, urb->pipe);
1740 if (retval < 0) {
1741 ERROR(tdev, "ep %02x couldn't clear halt, %d\n", ep, retval);
1742 return retval;
1743 }
1744
1745 /* host should use DATA0 again after clear halt */
1746 retval = simple_io(tdev, urb, 1, 0, 0, __func__);
1747
1748 return retval;
1749}
1750
1751static int halt_simple(struct usbtest_dev *dev)
1752{
1753 int ep;
1754 int retval = 0;
1755 struct urb *urb;
1756 struct usb_device *udev = testdev_to_usbdev(dev);
1757
1758 if (udev->speed == USB_SPEED_SUPER)
1759 urb = simple_alloc_urb(udev, 0, 1024, 0);
1760 else
1761 urb = simple_alloc_urb(udev, 0, 512, 0);
1762 if (urb == NULL)
1763 return -ENOMEM;
1764
1765 if (dev->in_pipe) {
1766 ep = usb_pipeendpoint(dev->in_pipe) | USB_DIR_IN;
1767 urb->pipe = dev->in_pipe;
1768 retval = test_halt(dev, ep, urb);
1769 if (retval < 0)
1770 goto done;
1771 }
1772
1773 if (dev->out_pipe) {
1774 ep = usb_pipeendpoint(dev->out_pipe);
1775 urb->pipe = dev->out_pipe;
1776 retval = test_halt(dev, ep, urb);
1777 }
1778done:
1779 simple_free_urb(urb);
1780 return retval;
1781}
1782
1783static int toggle_sync_simple(struct usbtest_dev *dev)
1784{
1785 int ep;
1786 int retval = 0;
1787 struct urb *urb;
1788 struct usb_device *udev = testdev_to_usbdev(dev);
1789 unsigned maxp = get_maxpacket(udev, dev->out_pipe);
1790
1791 /*
1792 * Create a URB that causes a transfer of uneven amount of data packets
1793 * This way the clear toggle has an impact on the data toggle sequence.
1794 * Use 2 maxpacket length packets and one zero packet.
1795 */
1796 urb = simple_alloc_urb(udev, 0, 2 * maxp, 0);
1797 if (urb == NULL)
1798 return -ENOMEM;
1799
1800 urb->transfer_flags |= URB_ZERO_PACKET;
1801
1802 ep = usb_pipeendpoint(dev->out_pipe);
1803 urb->pipe = dev->out_pipe;
1804 retval = test_toggle_sync(dev, ep, urb);
1805
1806 simple_free_urb(urb);
1807 return retval;
1808}
1809
1810/*-------------------------------------------------------------------------*/
1811
1812/* Control OUT tests use the vendor control requests from Intel's
1813 * USB 2.0 compliance test device: write a buffer, read it back.
1814 *
1815 * Intel's spec only _requires_ that it work for one packet, which
1816 * is pretty weak. Some HCDs place limits here; most devices will
1817 * need to be able to handle more than one OUT data packet. We'll
1818 * try whatever we're told to try.
1819 */
1820static int ctrl_out(struct usbtest_dev *dev,
1821 unsigned count, unsigned length, unsigned vary, unsigned offset)
1822{
1823 unsigned i, j, len;
1824 int retval;
1825 u8 *buf;
1826 char *what = "?";
1827 struct usb_device *udev;
1828
1829 if (length < 1 || length > 0xffff || vary >= length)
1830 return -EINVAL;
1831
1832 buf = kmalloc(length + offset, GFP_KERNEL);
1833 if (!buf)
1834 return -ENOMEM;
1835
1836 buf += offset;
1837 udev = testdev_to_usbdev(dev);
1838 len = length;
1839 retval = 0;
1840
1841 /* NOTE: hardware might well act differently if we pushed it
1842 * with lots back-to-back queued requests.
1843 */
1844 for (i = 0; i < count; i++) {
1845 /* write patterned data */
1846 for (j = 0; j < len; j++)
1847 buf[j] = (u8)(i + j);
1848 retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1849 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1850 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1851 if (retval != len) {
1852 what = "write";
1853 if (retval >= 0) {
1854 ERROR(dev, "ctrl_out, wlen %d (expected %d)\n",
1855 retval, len);
1856 retval = -EBADMSG;
1857 }
1858 break;
1859 }
1860
1861 /* read it back -- assuming nothing intervened!! */
1862 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
1863 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1864 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1865 if (retval != len) {
1866 what = "read";
1867 if (retval >= 0) {
1868 ERROR(dev, "ctrl_out, rlen %d (expected %d)\n",
1869 retval, len);
1870 retval = -EBADMSG;
1871 }
1872 break;
1873 }
1874
1875 /* fail if we can't verify */
1876 for (j = 0; j < len; j++) {
1877 if (buf[j] != (u8)(i + j)) {
1878 ERROR(dev, "ctrl_out, byte %d is %d not %d\n",
1879 j, buf[j], (u8)(i + j));
1880 retval = -EBADMSG;
1881 break;
1882 }
1883 }
1884 if (retval < 0) {
1885 what = "verify";
1886 break;
1887 }
1888
1889 len += vary;
1890
1891 /* [real world] the "zero bytes IN" case isn't really used.
1892 * hardware can easily trip up in this weird case, since its
1893 * status stage is IN, not OUT like other ep0in transfers.
1894 */
1895 if (len > length)
1896 len = realworld ? 1 : 0;
1897 }
1898
1899 if (retval < 0)
1900 ERROR(dev, "ctrl_out %s failed, code %d, count %d\n",
1901 what, retval, i);
1902
1903 kfree(buf - offset);
1904 return retval;
1905}
1906
1907/*-------------------------------------------------------------------------*/
1908
1909/* ISO/BULK tests ... mimics common usage
1910 * - buffer length is split into N packets (mostly maxpacket sized)
1911 * - multi-buffers according to sglen
1912 */
1913
1914struct transfer_context {
1915 unsigned count;
1916 unsigned pending;
1917 spinlock_t lock;
1918 struct completion done;
1919 int submit_error;
1920 unsigned long errors;
1921 unsigned long packet_count;
1922 struct usbtest_dev *dev;
1923 bool is_iso;
1924};
1925
1926static void complicated_callback(struct urb *urb)
1927{
1928 struct transfer_context *ctx = urb->context;
1929 unsigned long flags;
1930
1931 spin_lock_irqsave(&ctx->lock, flags);
1932 ctx->count--;
1933
1934 ctx->packet_count += urb->number_of_packets;
1935 if (urb->error_count > 0)
1936 ctx->errors += urb->error_count;
1937 else if (urb->status != 0)
1938 ctx->errors += (ctx->is_iso ? urb->number_of_packets : 1);
1939 else if (urb->actual_length != urb->transfer_buffer_length)
1940 ctx->errors++;
1941 else if (check_guard_bytes(ctx->dev, urb) != 0)
1942 ctx->errors++;
1943
1944 if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1945 && !ctx->submit_error) {
1946 int status = usb_submit_urb(urb, GFP_ATOMIC);
1947 switch (status) {
1948 case 0:
1949 goto done;
1950 default:
1951 dev_err(&ctx->dev->intf->dev,
1952 "resubmit err %d\n",
1953 status);
1954 fallthrough;
1955 case -ENODEV: /* disconnected */
1956 case -ESHUTDOWN: /* endpoint disabled */
1957 ctx->submit_error = 1;
1958 break;
1959 }
1960 }
1961
1962 ctx->pending--;
1963 if (ctx->pending == 0) {
1964 if (ctx->errors)
1965 dev_err(&ctx->dev->intf->dev,
1966 "during the test, %lu errors out of %lu\n",
1967 ctx->errors, ctx->packet_count);
1968 complete(&ctx->done);
1969 }
1970done:
1971 spin_unlock_irqrestore(&ctx->lock, flags);
1972}
1973
1974static struct urb *iso_alloc_urb(
1975 struct usb_device *udev,
1976 int pipe,
1977 struct usb_endpoint_descriptor *desc,
1978 long bytes,
1979 unsigned offset
1980)
1981{
1982 struct urb *urb;
1983 unsigned i, maxp, packets;
1984
1985 if (bytes < 0 || !desc)
1986 return NULL;
1987
1988 maxp = usb_endpoint_maxp(desc);
1989 if (udev->speed >= USB_SPEED_SUPER)
1990 maxp *= ss_isoc_get_packet_num(udev, pipe);
1991 else
1992 maxp *= usb_endpoint_maxp_mult(desc);
1993
1994 packets = DIV_ROUND_UP(bytes, maxp);
1995
1996 urb = usb_alloc_urb(packets, GFP_KERNEL);
1997 if (!urb)
1998 return urb;
1999 urb->dev = udev;
2000 urb->pipe = pipe;
2001
2002 urb->number_of_packets = packets;
2003 urb->transfer_buffer_length = bytes;
2004 urb->transfer_buffer = usb_alloc_coherent(udev, bytes + offset,
2005 GFP_KERNEL,
2006 &urb->transfer_dma);
2007 if (!urb->transfer_buffer) {
2008 usb_free_urb(urb);
2009 return NULL;
2010 }
2011 if (offset) {
2012 memset(urb->transfer_buffer, GUARD_BYTE, offset);
2013 urb->transfer_buffer += offset;
2014 urb->transfer_dma += offset;
2015 }
2016 /* For inbound transfers use guard byte so that test fails if
2017 data not correctly copied */
2018 memset(urb->transfer_buffer,
2019 usb_pipein(urb->pipe) ? GUARD_BYTE : 0,
2020 bytes);
2021
2022 for (i = 0; i < packets; i++) {
2023 /* here, only the last packet will be short */
2024 urb->iso_frame_desc[i].length = min((unsigned) bytes, maxp);
2025 bytes -= urb->iso_frame_desc[i].length;
2026
2027 urb->iso_frame_desc[i].offset = maxp * i;
2028 }
2029
2030 urb->complete = complicated_callback;
2031 /* urb->context = SET BY CALLER */
2032 urb->interval = 1 << (desc->bInterval - 1);
2033 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
2034 return urb;
2035}
2036
2037static int
2038test_queue(struct usbtest_dev *dev, struct usbtest_param_32 *param,
2039 int pipe, struct usb_endpoint_descriptor *desc, unsigned offset)
2040{
2041 struct transfer_context context;
2042 struct usb_device *udev;
2043 unsigned i;
2044 unsigned long packets = 0;
2045 int status = 0;
2046 struct urb **urbs;
2047
2048 if (!param->sglen || param->iterations > UINT_MAX / param->sglen)
2049 return -EINVAL;
2050
2051 if (param->sglen > MAX_SGLEN)
2052 return -EINVAL;
2053
2054 urbs = kcalloc(param->sglen, sizeof(*urbs), GFP_KERNEL);
2055 if (!urbs)
2056 return -ENOMEM;
2057
2058 memset(&context, 0, sizeof(context));
2059 context.count = param->iterations * param->sglen;
2060 context.dev = dev;
2061 context.is_iso = !!desc;
2062 init_completion(&context.done);
2063 spin_lock_init(&context.lock);
2064
2065 udev = testdev_to_usbdev(dev);
2066
2067 for (i = 0; i < param->sglen; i++) {
2068 if (context.is_iso)
2069 urbs[i] = iso_alloc_urb(udev, pipe, desc,
2070 param->length, offset);
2071 else
2072 urbs[i] = complicated_alloc_urb(udev, pipe,
2073 param->length, 0);
2074
2075 if (!urbs[i]) {
2076 status = -ENOMEM;
2077 goto fail;
2078 }
2079 packets += urbs[i]->number_of_packets;
2080 urbs[i]->context = &context;
2081 }
2082 packets *= param->iterations;
2083
2084 if (context.is_iso) {
2085 int transaction_num;
2086
2087 if (udev->speed >= USB_SPEED_SUPER)
2088 transaction_num = ss_isoc_get_packet_num(udev, pipe);
2089 else
2090 transaction_num = usb_endpoint_maxp_mult(desc);
2091
2092 dev_info(&dev->intf->dev,
2093 "iso period %d %sframes, wMaxPacket %d, transactions: %d\n",
2094 1 << (desc->bInterval - 1),
2095 (udev->speed >= USB_SPEED_HIGH) ? "micro" : "",
2096 usb_endpoint_maxp(desc),
2097 transaction_num);
2098
2099 dev_info(&dev->intf->dev,
2100 "total %lu msec (%lu packets)\n",
2101 (packets * (1 << (desc->bInterval - 1)))
2102 / ((udev->speed >= USB_SPEED_HIGH) ? 8 : 1),
2103 packets);
2104 }
2105
2106 spin_lock_irq(&context.lock);
2107 for (i = 0; i < param->sglen; i++) {
2108 ++context.pending;
2109 status = usb_submit_urb(urbs[i], GFP_ATOMIC);
2110 if (status < 0) {
2111 ERROR(dev, "submit iso[%d], error %d\n", i, status);
2112 if (i == 0) {
2113 spin_unlock_irq(&context.lock);
2114 goto fail;
2115 }
2116
2117 simple_free_urb(urbs[i]);
2118 urbs[i] = NULL;
2119 context.pending--;
2120 context.submit_error = 1;
2121 break;
2122 }
2123 }
2124 spin_unlock_irq(&context.lock);
2125
2126 wait_for_completion(&context.done);
2127
2128 for (i = 0; i < param->sglen; i++) {
2129 if (urbs[i])
2130 simple_free_urb(urbs[i]);
2131 }
2132 /*
2133 * Isochronous transfers are expected to fail sometimes. As an
2134 * arbitrary limit, we will report an error if any submissions
2135 * fail or if the transfer failure rate is > 10%.
2136 */
2137 if (status != 0)
2138 ;
2139 else if (context.submit_error)
2140 status = -EACCES;
2141 else if (context.errors >
2142 (context.is_iso ? context.packet_count / 10 : 0))
2143 status = -EIO;
2144
2145 kfree(urbs);
2146 return status;
2147
2148fail:
2149 for (i = 0; i < param->sglen; i++) {
2150 if (urbs[i])
2151 simple_free_urb(urbs[i]);
2152 }
2153
2154 kfree(urbs);
2155 return status;
2156}
2157
2158static int test_unaligned_bulk(
2159 struct usbtest_dev *tdev,
2160 int pipe,
2161 unsigned length,
2162 int iterations,
2163 unsigned transfer_flags,
2164 const char *label)
2165{
2166 int retval;
2167 struct urb *urb = usbtest_alloc_urb(testdev_to_usbdev(tdev),
2168 pipe, length, transfer_flags, 1, 0, simple_callback);
2169
2170 if (!urb)
2171 return -ENOMEM;
2172
2173 retval = simple_io(tdev, urb, iterations, 0, 0, label);
2174 simple_free_urb(urb);
2175 return retval;
2176}
2177
2178/* Run tests. */
2179static int
2180usbtest_do_ioctl(struct usb_interface *intf, struct usbtest_param_32 *param)
2181{
2182 struct usbtest_dev *dev = usb_get_intfdata(intf);
2183 struct usb_device *udev = testdev_to_usbdev(dev);
2184 struct urb *urb;
2185 struct scatterlist *sg;
2186 struct usb_sg_request req;
2187 unsigned i;
2188 int retval = -EOPNOTSUPP;
2189
2190 if (param->iterations <= 0)
2191 return -EINVAL;
2192 if (param->sglen > MAX_SGLEN)
2193 return -EINVAL;
2194 /*
2195 * Just a bunch of test cases that every HCD is expected to handle.
2196 *
2197 * Some may need specific firmware, though it'd be good to have
2198 * one firmware image to handle all the test cases.
2199 *
2200 * FIXME add more tests! cancel requests, verify the data, control
2201 * queueing, concurrent read+write threads, and so on.
2202 */
2203 switch (param->test_num) {
2204
2205 case 0:
2206 dev_info(&intf->dev, "TEST 0: NOP\n");
2207 retval = 0;
2208 break;
2209
2210 /* Simple non-queued bulk I/O tests */
2211 case 1:
2212 if (dev->out_pipe == 0)
2213 break;
2214 dev_info(&intf->dev,
2215 "TEST 1: write %d bytes %u times\n",
2216 param->length, param->iterations);
2217 urb = simple_alloc_urb(udev, dev->out_pipe, param->length, 0);
2218 if (!urb) {
2219 retval = -ENOMEM;
2220 break;
2221 }
2222 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2223 retval = simple_io(dev, urb, param->iterations, 0, 0, "test1");
2224 simple_free_urb(urb);
2225 break;
2226 case 2:
2227 if (dev->in_pipe == 0)
2228 break;
2229 dev_info(&intf->dev,
2230 "TEST 2: read %d bytes %u times\n",
2231 param->length, param->iterations);
2232 urb = simple_alloc_urb(udev, dev->in_pipe, param->length, 0);
2233 if (!urb) {
2234 retval = -ENOMEM;
2235 break;
2236 }
2237 /* FIRMWARE: bulk source (maybe generates short writes) */
2238 retval = simple_io(dev, urb, param->iterations, 0, 0, "test2");
2239 simple_free_urb(urb);
2240 break;
2241 case 3:
2242 if (dev->out_pipe == 0 || param->vary == 0)
2243 break;
2244 dev_info(&intf->dev,
2245 "TEST 3: write/%d 0..%d bytes %u times\n",
2246 param->vary, param->length, param->iterations);
2247 urb = simple_alloc_urb(udev, dev->out_pipe, param->length, 0);
2248 if (!urb) {
2249 retval = -ENOMEM;
2250 break;
2251 }
2252 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2253 retval = simple_io(dev, urb, param->iterations, param->vary,
2254 0, "test3");
2255 simple_free_urb(urb);
2256 break;
2257 case 4:
2258 if (dev->in_pipe == 0 || param->vary == 0)
2259 break;
2260 dev_info(&intf->dev,
2261 "TEST 4: read/%d 0..%d bytes %u times\n",
2262 param->vary, param->length, param->iterations);
2263 urb = simple_alloc_urb(udev, dev->in_pipe, param->length, 0);
2264 if (!urb) {
2265 retval = -ENOMEM;
2266 break;
2267 }
2268 /* FIRMWARE: bulk source (maybe generates short writes) */
2269 retval = simple_io(dev, urb, param->iterations, param->vary,
2270 0, "test4");
2271 simple_free_urb(urb);
2272 break;
2273
2274 /* Queued bulk I/O tests */
2275 case 5:
2276 if (dev->out_pipe == 0 || param->sglen == 0)
2277 break;
2278 dev_info(&intf->dev,
2279 "TEST 5: write %d sglists %d entries of %d bytes\n",
2280 param->iterations,
2281 param->sglen, param->length);
2282 sg = alloc_sglist(param->sglen, param->length,
2283 0, dev, dev->out_pipe);
2284 if (!sg) {
2285 retval = -ENOMEM;
2286 break;
2287 }
2288 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2289 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
2290 &req, sg, param->sglen);
2291 free_sglist(sg, param->sglen);
2292 break;
2293
2294 case 6:
2295 if (dev->in_pipe == 0 || param->sglen == 0)
2296 break;
2297 dev_info(&intf->dev,
2298 "TEST 6: read %d sglists %d entries of %d bytes\n",
2299 param->iterations,
2300 param->sglen, param->length);
2301 sg = alloc_sglist(param->sglen, param->length,
2302 0, dev, dev->in_pipe);
2303 if (!sg) {
2304 retval = -ENOMEM;
2305 break;
2306 }
2307 /* FIRMWARE: bulk source (maybe generates short writes) */
2308 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
2309 &req, sg, param->sglen);
2310 free_sglist(sg, param->sglen);
2311 break;
2312 case 7:
2313 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
2314 break;
2315 dev_info(&intf->dev,
2316 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
2317 param->vary, param->iterations,
2318 param->sglen, param->length);
2319 sg = alloc_sglist(param->sglen, param->length,
2320 param->vary, dev, dev->out_pipe);
2321 if (!sg) {
2322 retval = -ENOMEM;
2323 break;
2324 }
2325 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2326 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
2327 &req, sg, param->sglen);
2328 free_sglist(sg, param->sglen);
2329 break;
2330 case 8:
2331 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
2332 break;
2333 dev_info(&intf->dev,
2334 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
2335 param->vary, param->iterations,
2336 param->sglen, param->length);
2337 sg = alloc_sglist(param->sglen, param->length,
2338 param->vary, dev, dev->in_pipe);
2339 if (!sg) {
2340 retval = -ENOMEM;
2341 break;
2342 }
2343 /* FIRMWARE: bulk source (maybe generates short writes) */
2344 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
2345 &req, sg, param->sglen);
2346 free_sglist(sg, param->sglen);
2347 break;
2348
2349 /* non-queued sanity tests for control (chapter 9 subset) */
2350 case 9:
2351 retval = 0;
2352 dev_info(&intf->dev,
2353 "TEST 9: ch9 (subset) control tests, %d times\n",
2354 param->iterations);
2355 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2356 retval = ch9_postconfig(dev);
2357 if (retval)
2358 dev_err(&intf->dev, "ch9 subset failed, "
2359 "iterations left %d\n", i);
2360 break;
2361
2362 /* queued control messaging */
2363 case 10:
2364 retval = 0;
2365 dev_info(&intf->dev,
2366 "TEST 10: queue %d control calls, %d times\n",
2367 param->sglen,
2368 param->iterations);
2369 retval = test_ctrl_queue(dev, param);
2370 break;
2371
2372 /* simple non-queued unlinks (ring with one urb) */
2373 case 11:
2374 if (dev->in_pipe == 0 || !param->length)
2375 break;
2376 retval = 0;
2377 dev_info(&intf->dev, "TEST 11: unlink %d reads of %d\n",
2378 param->iterations, param->length);
2379 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2380 retval = unlink_simple(dev, dev->in_pipe,
2381 param->length);
2382 if (retval)
2383 dev_err(&intf->dev, "unlink reads failed %d, "
2384 "iterations left %d\n", retval, i);
2385 break;
2386 case 12:
2387 if (dev->out_pipe == 0 || !param->length)
2388 break;
2389 retval = 0;
2390 dev_info(&intf->dev, "TEST 12: unlink %d writes of %d\n",
2391 param->iterations, param->length);
2392 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2393 retval = unlink_simple(dev, dev->out_pipe,
2394 param->length);
2395 if (retval)
2396 dev_err(&intf->dev, "unlink writes failed %d, "
2397 "iterations left %d\n", retval, i);
2398 break;
2399
2400 /* ep halt tests */
2401 case 13:
2402 if (dev->out_pipe == 0 && dev->in_pipe == 0)
2403 break;
2404 retval = 0;
2405 dev_info(&intf->dev, "TEST 13: set/clear %d halts\n",
2406 param->iterations);
2407 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2408 retval = halt_simple(dev);
2409
2410 if (retval)
2411 ERROR(dev, "halts failed, iterations left %d\n", i);
2412 break;
2413
2414 /* control write tests */
2415 case 14:
2416 if (!dev->info->ctrl_out)
2417 break;
2418 dev_info(&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
2419 param->iterations,
2420 realworld ? 1 : 0, param->length,
2421 param->vary);
2422 retval = ctrl_out(dev, param->iterations,
2423 param->length, param->vary, 0);
2424 break;
2425
2426 /* iso write tests */
2427 case 15:
2428 if (dev->out_iso_pipe == 0 || param->sglen == 0)
2429 break;
2430 dev_info(&intf->dev,
2431 "TEST 15: write %d iso, %d entries of %d bytes\n",
2432 param->iterations,
2433 param->sglen, param->length);
2434 /* FIRMWARE: iso sink */
2435 retval = test_queue(dev, param,
2436 dev->out_iso_pipe, dev->iso_out, 0);
2437 break;
2438
2439 /* iso read tests */
2440 case 16:
2441 if (dev->in_iso_pipe == 0 || param->sglen == 0)
2442 break;
2443 dev_info(&intf->dev,
2444 "TEST 16: read %d iso, %d entries of %d bytes\n",
2445 param->iterations,
2446 param->sglen, param->length);
2447 /* FIRMWARE: iso source */
2448 retval = test_queue(dev, param,
2449 dev->in_iso_pipe, dev->iso_in, 0);
2450 break;
2451
2452 /* FIXME scatterlist cancel (needs helper thread) */
2453
2454 /* Tests for bulk I/O using DMA mapping by core and odd address */
2455 case 17:
2456 if (dev->out_pipe == 0)
2457 break;
2458 dev_info(&intf->dev,
2459 "TEST 17: write odd addr %d bytes %u times core map\n",
2460 param->length, param->iterations);
2461
2462 retval = test_unaligned_bulk(
2463 dev, dev->out_pipe,
2464 param->length, param->iterations,
2465 0, "test17");
2466 break;
2467
2468 case 18:
2469 if (dev->in_pipe == 0)
2470 break;
2471 dev_info(&intf->dev,
2472 "TEST 18: read odd addr %d bytes %u times core map\n",
2473 param->length, param->iterations);
2474
2475 retval = test_unaligned_bulk(
2476 dev, dev->in_pipe,
2477 param->length, param->iterations,
2478 0, "test18");
2479 break;
2480
2481 /* Tests for bulk I/O using premapped coherent buffer and odd address */
2482 case 19:
2483 if (dev->out_pipe == 0)
2484 break;
2485 dev_info(&intf->dev,
2486 "TEST 19: write odd addr %d bytes %u times premapped\n",
2487 param->length, param->iterations);
2488
2489 retval = test_unaligned_bulk(
2490 dev, dev->out_pipe,
2491 param->length, param->iterations,
2492 URB_NO_TRANSFER_DMA_MAP, "test19");
2493 break;
2494
2495 case 20:
2496 if (dev->in_pipe == 0)
2497 break;
2498 dev_info(&intf->dev,
2499 "TEST 20: read odd addr %d bytes %u times premapped\n",
2500 param->length, param->iterations);
2501
2502 retval = test_unaligned_bulk(
2503 dev, dev->in_pipe,
2504 param->length, param->iterations,
2505 URB_NO_TRANSFER_DMA_MAP, "test20");
2506 break;
2507
2508 /* control write tests with unaligned buffer */
2509 case 21:
2510 if (!dev->info->ctrl_out)
2511 break;
2512 dev_info(&intf->dev,
2513 "TEST 21: %d ep0out odd addr, %d..%d vary %d\n",
2514 param->iterations,
2515 realworld ? 1 : 0, param->length,
2516 param->vary);
2517 retval = ctrl_out(dev, param->iterations,
2518 param->length, param->vary, 1);
2519 break;
2520
2521 /* unaligned iso tests */
2522 case 22:
2523 if (dev->out_iso_pipe == 0 || param->sglen == 0)
2524 break;
2525 dev_info(&intf->dev,
2526 "TEST 22: write %d iso odd, %d entries of %d bytes\n",
2527 param->iterations,
2528 param->sglen, param->length);
2529 retval = test_queue(dev, param,
2530 dev->out_iso_pipe, dev->iso_out, 1);
2531 break;
2532
2533 case 23:
2534 if (dev->in_iso_pipe == 0 || param->sglen == 0)
2535 break;
2536 dev_info(&intf->dev,
2537 "TEST 23: read %d iso odd, %d entries of %d bytes\n",
2538 param->iterations,
2539 param->sglen, param->length);
2540 retval = test_queue(dev, param,
2541 dev->in_iso_pipe, dev->iso_in, 1);
2542 break;
2543
2544 /* unlink URBs from a bulk-OUT queue */
2545 case 24:
2546 if (dev->out_pipe == 0 || !param->length || param->sglen < 4)
2547 break;
2548 retval = 0;
2549 dev_info(&intf->dev, "TEST 24: unlink from %d queues of "
2550 "%d %d-byte writes\n",
2551 param->iterations, param->sglen, param->length);
2552 for (i = param->iterations; retval == 0 && i > 0; --i) {
2553 retval = unlink_queued(dev, dev->out_pipe,
2554 param->sglen, param->length);
2555 if (retval) {
2556 dev_err(&intf->dev,
2557 "unlink queued writes failed %d, "
2558 "iterations left %d\n", retval, i);
2559 break;
2560 }
2561 }
2562 break;
2563
2564 /* Simple non-queued interrupt I/O tests */
2565 case 25:
2566 if (dev->out_int_pipe == 0)
2567 break;
2568 dev_info(&intf->dev,
2569 "TEST 25: write %d bytes %u times\n",
2570 param->length, param->iterations);
2571 urb = simple_alloc_urb(udev, dev->out_int_pipe, param->length,
2572 dev->int_out->bInterval);
2573 if (!urb) {
2574 retval = -ENOMEM;
2575 break;
2576 }
2577 /* FIRMWARE: interrupt sink (maybe accepts short writes) */
2578 retval = simple_io(dev, urb, param->iterations, 0, 0, "test25");
2579 simple_free_urb(urb);
2580 break;
2581 case 26:
2582 if (dev->in_int_pipe == 0)
2583 break;
2584 dev_info(&intf->dev,
2585 "TEST 26: read %d bytes %u times\n",
2586 param->length, param->iterations);
2587 urb = simple_alloc_urb(udev, dev->in_int_pipe, param->length,
2588 dev->int_in->bInterval);
2589 if (!urb) {
2590 retval = -ENOMEM;
2591 break;
2592 }
2593 /* FIRMWARE: interrupt source (maybe generates short writes) */
2594 retval = simple_io(dev, urb, param->iterations, 0, 0, "test26");
2595 simple_free_urb(urb);
2596 break;
2597 case 27:
2598 /* We do performance test, so ignore data compare */
2599 if (dev->out_pipe == 0 || param->sglen == 0 || pattern != 0)
2600 break;
2601 dev_info(&intf->dev,
2602 "TEST 27: bulk write %dMbytes\n", (param->iterations *
2603 param->sglen * param->length) / (1024 * 1024));
2604 retval = test_queue(dev, param,
2605 dev->out_pipe, NULL, 0);
2606 break;
2607 case 28:
2608 if (dev->in_pipe == 0 || param->sglen == 0 || pattern != 0)
2609 break;
2610 dev_info(&intf->dev,
2611 "TEST 28: bulk read %dMbytes\n", (param->iterations *
2612 param->sglen * param->length) / (1024 * 1024));
2613 retval = test_queue(dev, param,
2614 dev->in_pipe, NULL, 0);
2615 break;
2616 /* Test data Toggle/seq_nr clear between bulk out transfers */
2617 case 29:
2618 if (dev->out_pipe == 0)
2619 break;
2620 retval = 0;
2621 dev_info(&intf->dev, "TEST 29: Clear toggle between bulk writes %d times\n",
2622 param->iterations);
2623 for (i = param->iterations; retval == 0 && i > 0; --i)
2624 retval = toggle_sync_simple(dev);
2625
2626 if (retval)
2627 ERROR(dev, "toggle sync failed, iterations left %d\n",
2628 i);
2629 break;
2630 }
2631 return retval;
2632}
2633
2634/*-------------------------------------------------------------------------*/
2635
2636/* We only have this one interface to user space, through usbfs.
2637 * User mode code can scan usbfs to find N different devices (maybe on
2638 * different busses) to use when testing, and allocate one thread per
2639 * test. So discovery is simplified, and we have no device naming issues.
2640 *
2641 * Don't use these only as stress/load tests. Use them along with with
2642 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
2643 * video capture, and so on. Run different tests at different times, in
2644 * different sequences. Nothing here should interact with other devices,
2645 * except indirectly by consuming USB bandwidth and CPU resources for test
2646 * threads and request completion. But the only way to know that for sure
2647 * is to test when HC queues are in use by many devices.
2648 *
2649 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
2650 * it locks out usbcore in certain code paths. Notably, if you disconnect
2651 * the device-under-test, hub_wq will wait block forever waiting for the
2652 * ioctl to complete ... so that usb_disconnect() can abort the pending
2653 * urbs and then call usbtest_disconnect(). To abort a test, you're best
2654 * off just killing the userspace task and waiting for it to exit.
2655 */
2656
2657static int
2658usbtest_ioctl(struct usb_interface *intf, unsigned int code, void *buf)
2659{
2660
2661 struct usbtest_dev *dev = usb_get_intfdata(intf);
2662 struct usbtest_param_64 *param_64 = buf;
2663 struct usbtest_param_32 temp;
2664 struct usbtest_param_32 *param_32 = buf;
2665 struct timespec64 start;
2666 struct timespec64 end;
2667 struct timespec64 duration;
2668 int retval = -EOPNOTSUPP;
2669
2670 /* FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is. */
2671
2672 pattern = mod_pattern;
2673
2674 if (mutex_lock_interruptible(&dev->lock))
2675 return -ERESTARTSYS;
2676
2677 /* FIXME: What if a system sleep starts while a test is running? */
2678
2679 /* some devices, like ez-usb default devices, need a non-default
2680 * altsetting to have any active endpoints. some tests change
2681 * altsettings; force a default so most tests don't need to check.
2682 */
2683 if (dev->info->alt >= 0) {
2684 if (intf->altsetting->desc.bInterfaceNumber) {
2685 retval = -ENODEV;
2686 goto free_mutex;
2687 }
2688 retval = set_altsetting(dev, dev->info->alt);
2689 if (retval) {
2690 dev_err(&intf->dev,
2691 "set altsetting to %d failed, %d\n",
2692 dev->info->alt, retval);
2693 goto free_mutex;
2694 }
2695 }
2696
2697 switch (code) {
2698 case USBTEST_REQUEST_64:
2699 temp.test_num = param_64->test_num;
2700 temp.iterations = param_64->iterations;
2701 temp.length = param_64->length;
2702 temp.sglen = param_64->sglen;
2703 temp.vary = param_64->vary;
2704 param_32 = &temp;
2705 break;
2706
2707 case USBTEST_REQUEST_32:
2708 break;
2709
2710 default:
2711 retval = -EOPNOTSUPP;
2712 goto free_mutex;
2713 }
2714
2715 ktime_get_ts64(&start);
2716
2717 retval = usbtest_do_ioctl(intf, param_32);
2718 if (retval < 0)
2719 goto free_mutex;
2720
2721 ktime_get_ts64(&end);
2722
2723 duration = timespec64_sub(end, start);
2724
2725 temp.duration_sec = duration.tv_sec;
2726 temp.duration_usec = duration.tv_nsec/NSEC_PER_USEC;
2727
2728 switch (code) {
2729 case USBTEST_REQUEST_32:
2730 param_32->duration_sec = temp.duration_sec;
2731 param_32->duration_usec = temp.duration_usec;
2732 break;
2733
2734 case USBTEST_REQUEST_64:
2735 param_64->duration_sec = temp.duration_sec;
2736 param_64->duration_usec = temp.duration_usec;
2737 break;
2738 }
2739
2740free_mutex:
2741 mutex_unlock(&dev->lock);
2742 return retval;
2743}
2744
2745/*-------------------------------------------------------------------------*/
2746
2747static unsigned force_interrupt;
2748module_param(force_interrupt, uint, 0);
2749MODULE_PARM_DESC(force_interrupt, "0 = test default; else interrupt");
2750
2751#ifdef GENERIC
2752static unsigned short vendor;
2753module_param(vendor, ushort, 0);
2754MODULE_PARM_DESC(vendor, "vendor code (from usb-if)");
2755
2756static unsigned short product;
2757module_param(product, ushort, 0);
2758MODULE_PARM_DESC(product, "product code (from vendor)");
2759#endif
2760
2761static int
2762usbtest_probe(struct usb_interface *intf, const struct usb_device_id *id)
2763{
2764 struct usb_device *udev;
2765 struct usbtest_dev *dev;
2766 struct usbtest_info *info;
2767 char *rtest, *wtest;
2768 char *irtest, *iwtest;
2769 char *intrtest, *intwtest;
2770
2771 udev = interface_to_usbdev(intf);
2772
2773#ifdef GENERIC
2774 /* specify devices by module parameters? */
2775 if (id->match_flags == 0) {
2776 /* vendor match required, product match optional */
2777 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
2778 return -ENODEV;
2779 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
2780 return -ENODEV;
2781 dev_info(&intf->dev, "matched module params, "
2782 "vend=0x%04x prod=0x%04x\n",
2783 le16_to_cpu(udev->descriptor.idVendor),
2784 le16_to_cpu(udev->descriptor.idProduct));
2785 }
2786#endif
2787
2788 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2789 if (!dev)
2790 return -ENOMEM;
2791 info = (struct usbtest_info *) id->driver_info;
2792 dev->info = info;
2793 mutex_init(&dev->lock);
2794
2795 dev->intf = intf;
2796
2797 /* cacheline-aligned scratch for i/o */
2798 dev->buf = kmalloc(TBUF_SIZE, GFP_KERNEL);
2799 if (dev->buf == NULL) {
2800 kfree(dev);
2801 return -ENOMEM;
2802 }
2803
2804 /* NOTE this doesn't yet test the handful of difference that are
2805 * visible with high speed interrupts: bigger maxpacket (1K) and
2806 * "high bandwidth" modes (up to 3 packets/uframe).
2807 */
2808 rtest = wtest = "";
2809 irtest = iwtest = "";
2810 intrtest = intwtest = "";
2811 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
2812 if (info->ep_in) {
2813 dev->in_pipe = usb_rcvintpipe(udev, info->ep_in);
2814 rtest = " intr-in";
2815 }
2816 if (info->ep_out) {
2817 dev->out_pipe = usb_sndintpipe(udev, info->ep_out);
2818 wtest = " intr-out";
2819 }
2820 } else {
2821 if (override_alt >= 0 || info->autoconf) {
2822 int status;
2823
2824 status = get_endpoints(dev, intf);
2825 if (status < 0) {
2826 WARNING(dev, "couldn't get endpoints, %d\n",
2827 status);
2828 kfree(dev->buf);
2829 kfree(dev);
2830 return status;
2831 }
2832 /* may find bulk or ISO pipes */
2833 } else {
2834 if (info->ep_in)
2835 dev->in_pipe = usb_rcvbulkpipe(udev,
2836 info->ep_in);
2837 if (info->ep_out)
2838 dev->out_pipe = usb_sndbulkpipe(udev,
2839 info->ep_out);
2840 }
2841 if (dev->in_pipe)
2842 rtest = " bulk-in";
2843 if (dev->out_pipe)
2844 wtest = " bulk-out";
2845 if (dev->in_iso_pipe)
2846 irtest = " iso-in";
2847 if (dev->out_iso_pipe)
2848 iwtest = " iso-out";
2849 if (dev->in_int_pipe)
2850 intrtest = " int-in";
2851 if (dev->out_int_pipe)
2852 intwtest = " int-out";
2853 }
2854
2855 usb_set_intfdata(intf, dev);
2856 dev_info(&intf->dev, "%s\n", info->name);
2857 dev_info(&intf->dev, "%s {control%s%s%s%s%s%s%s} tests%s\n",
2858 usb_speed_string(udev->speed),
2859 info->ctrl_out ? " in/out" : "",
2860 rtest, wtest,
2861 irtest, iwtest,
2862 intrtest, intwtest,
2863 info->alt >= 0 ? " (+alt)" : "");
2864 return 0;
2865}
2866
2867static int usbtest_suspend(struct usb_interface *intf, pm_message_t message)
2868{
2869 return 0;
2870}
2871
2872static int usbtest_resume(struct usb_interface *intf)
2873{
2874 return 0;
2875}
2876
2877
2878static void usbtest_disconnect(struct usb_interface *intf)
2879{
2880 struct usbtest_dev *dev = usb_get_intfdata(intf);
2881
2882 usb_set_intfdata(intf, NULL);
2883 dev_dbg(&intf->dev, "disconnect\n");
2884 kfree(dev->buf);
2885 kfree(dev);
2886}
2887
2888/* Basic testing only needs a device that can source or sink bulk traffic.
2889 * Any device can test control transfers (default with GENERIC binding).
2890 *
2891 * Several entries work with the default EP0 implementation that's built
2892 * into EZ-USB chips. There's a default vendor ID which can be overridden
2893 * by (very) small config EEPROMS, but otherwise all these devices act
2894 * identically until firmware is loaded: only EP0 works. It turns out
2895 * to be easy to make other endpoints work, without modifying that EP0
2896 * behavior. For now, we expect that kind of firmware.
2897 */
2898
2899/* an21xx or fx versions of ez-usb */
2900static struct usbtest_info ez1_info = {
2901 .name = "EZ-USB device",
2902 .ep_in = 2,
2903 .ep_out = 2,
2904 .alt = 1,
2905};
2906
2907/* fx2 version of ez-usb */
2908static struct usbtest_info ez2_info = {
2909 .name = "FX2 device",
2910 .ep_in = 6,
2911 .ep_out = 2,
2912 .alt = 1,
2913};
2914
2915/* ezusb family device with dedicated usb test firmware,
2916 */
2917static struct usbtest_info fw_info = {
2918 .name = "usb test device",
2919 .ep_in = 2,
2920 .ep_out = 2,
2921 .alt = 1,
2922 .autoconf = 1, /* iso and ctrl_out need autoconf */
2923 .ctrl_out = 1,
2924 .iso = 1, /* iso_ep's are #8 in/out */
2925};
2926
2927/* peripheral running Linux and 'zero.c' test firmware, or
2928 * its user-mode cousin. different versions of this use
2929 * different hardware with the same vendor/product codes.
2930 * host side MUST rely on the endpoint descriptors.
2931 */
2932static struct usbtest_info gz_info = {
2933 .name = "Linux gadget zero",
2934 .autoconf = 1,
2935 .ctrl_out = 1,
2936 .iso = 1,
2937 .intr = 1,
2938 .alt = 0,
2939};
2940
2941static struct usbtest_info um_info = {
2942 .name = "Linux user mode test driver",
2943 .autoconf = 1,
2944 .alt = -1,
2945};
2946
2947static struct usbtest_info um2_info = {
2948 .name = "Linux user mode ISO test driver",
2949 .autoconf = 1,
2950 .iso = 1,
2951 .alt = -1,
2952};
2953
2954#ifdef IBOT2
2955/* this is a nice source of high speed bulk data;
2956 * uses an FX2, with firmware provided in the device
2957 */
2958static struct usbtest_info ibot2_info = {
2959 .name = "iBOT2 webcam",
2960 .ep_in = 2,
2961 .alt = -1,
2962};
2963#endif
2964
2965#ifdef GENERIC
2966/* we can use any device to test control traffic */
2967static struct usbtest_info generic_info = {
2968 .name = "Generic USB device",
2969 .alt = -1,
2970};
2971#endif
2972
2973
2974static const struct usb_device_id id_table[] = {
2975
2976 /*-------------------------------------------------------------*/
2977
2978 /* EZ-USB devices which download firmware to replace (or in our
2979 * case augment) the default device implementation.
2980 */
2981
2982 /* generic EZ-USB FX controller */
2983 { USB_DEVICE(0x0547, 0x2235),
2984 .driver_info = (unsigned long) &ez1_info,
2985 },
2986
2987 /* CY3671 development board with EZ-USB FX */
2988 { USB_DEVICE(0x0547, 0x0080),
2989 .driver_info = (unsigned long) &ez1_info,
2990 },
2991
2992 /* generic EZ-USB FX2 controller (or development board) */
2993 { USB_DEVICE(0x04b4, 0x8613),
2994 .driver_info = (unsigned long) &ez2_info,
2995 },
2996
2997 /* re-enumerated usb test device firmware */
2998 { USB_DEVICE(0xfff0, 0xfff0),
2999 .driver_info = (unsigned long) &fw_info,
3000 },
3001
3002 /* "Gadget Zero" firmware runs under Linux */
3003 { USB_DEVICE(0x0525, 0xa4a0),
3004 .driver_info = (unsigned long) &gz_info,
3005 },
3006
3007 /* so does a user-mode variant */
3008 { USB_DEVICE(0x0525, 0xa4a4),
3009 .driver_info = (unsigned long) &um_info,
3010 },
3011
3012 /* ... and a user-mode variant that talks iso */
3013 { USB_DEVICE(0x0525, 0xa4a3),
3014 .driver_info = (unsigned long) &um2_info,
3015 },
3016
3017#ifdef KEYSPAN_19Qi
3018 /* Keyspan 19qi uses an21xx (original EZ-USB) */
3019 /* this does not coexist with the real Keyspan 19qi driver! */
3020 { USB_DEVICE(0x06cd, 0x010b),
3021 .driver_info = (unsigned long) &ez1_info,
3022 },
3023#endif
3024
3025 /*-------------------------------------------------------------*/
3026
3027#ifdef IBOT2
3028 /* iBOT2 makes a nice source of high speed bulk-in data */
3029 /* this does not coexist with a real iBOT2 driver! */
3030 { USB_DEVICE(0x0b62, 0x0059),
3031 .driver_info = (unsigned long) &ibot2_info,
3032 },
3033#endif
3034
3035 /*-------------------------------------------------------------*/
3036
3037#ifdef GENERIC
3038 /* module params can specify devices to use for control tests */
3039 { .driver_info = (unsigned long) &generic_info, },
3040#endif
3041
3042 /*-------------------------------------------------------------*/
3043
3044 { }
3045};
3046MODULE_DEVICE_TABLE(usb, id_table);
3047
3048static struct usb_driver usbtest_driver = {
3049 .name = "usbtest",
3050 .id_table = id_table,
3051 .probe = usbtest_probe,
3052 .unlocked_ioctl = usbtest_ioctl,
3053 .disconnect = usbtest_disconnect,
3054 .suspend = usbtest_suspend,
3055 .resume = usbtest_resume,
3056};
3057
3058/*-------------------------------------------------------------------------*/
3059
3060static int __init usbtest_init(void)
3061{
3062#ifdef GENERIC
3063 if (vendor)
3064 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor, product);
3065#endif
3066 return usb_register(&usbtest_driver);
3067}
3068module_init(usbtest_init);
3069
3070static void __exit usbtest_exit(void)
3071{
3072 usb_deregister(&usbtest_driver);
3073}
3074module_exit(usbtest_exit);
3075
3076MODULE_DESCRIPTION("USB Core/HCD Testing Driver");
3077MODULE_LICENSE("GPL");
3078
1#include <linux/kernel.h>
2#include <linux/errno.h>
3#include <linux/init.h>
4#include <linux/slab.h>
5#include <linux/mm.h>
6#include <linux/module.h>
7#include <linux/moduleparam.h>
8#include <linux/scatterlist.h>
9#include <linux/mutex.h>
10#include <linux/timer.h>
11#include <linux/usb.h>
12
13#define SIMPLE_IO_TIMEOUT 10000 /* in milliseconds */
14
15/*-------------------------------------------------------------------------*/
16
17static int override_alt = -1;
18module_param_named(alt, override_alt, int, 0644);
19MODULE_PARM_DESC(alt, ">= 0 to override altsetting selection");
20static void complicated_callback(struct urb *urb);
21
22/*-------------------------------------------------------------------------*/
23
24/* FIXME make these public somewhere; usbdevfs.h? */
25
26/* Parameter for usbtest driver. */
27struct usbtest_param_32 {
28 /* inputs */
29 __u32 test_num; /* 0..(TEST_CASES-1) */
30 __u32 iterations;
31 __u32 length;
32 __u32 vary;
33 __u32 sglen;
34
35 /* outputs */
36 __s32 duration_sec;
37 __s32 duration_usec;
38};
39
40/*
41 * Compat parameter to the usbtest driver.
42 * This supports older user space binaries compiled with 64 bit compiler.
43 */
44struct usbtest_param_64 {
45 /* inputs */
46 __u32 test_num; /* 0..(TEST_CASES-1) */
47 __u32 iterations;
48 __u32 length;
49 __u32 vary;
50 __u32 sglen;
51
52 /* outputs */
53 __s64 duration_sec;
54 __s64 duration_usec;
55};
56
57/* IOCTL interface to the driver. */
58#define USBTEST_REQUEST_32 _IOWR('U', 100, struct usbtest_param_32)
59/* COMPAT IOCTL interface to the driver. */
60#define USBTEST_REQUEST_64 _IOWR('U', 100, struct usbtest_param_64)
61
62/*-------------------------------------------------------------------------*/
63
64#define GENERIC /* let probe() bind using module params */
65
66/* Some devices that can be used for testing will have "real" drivers.
67 * Entries for those need to be enabled here by hand, after disabling
68 * that "real" driver.
69 */
70//#define IBOT2 /* grab iBOT2 webcams */
71//#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
72
73/*-------------------------------------------------------------------------*/
74
75struct usbtest_info {
76 const char *name;
77 u8 ep_in; /* bulk/intr source */
78 u8 ep_out; /* bulk/intr sink */
79 unsigned autoconf:1;
80 unsigned ctrl_out:1;
81 unsigned iso:1; /* try iso in/out */
82 unsigned intr:1; /* try interrupt in/out */
83 int alt;
84};
85
86/* this is accessed only through usbfs ioctl calls.
87 * one ioctl to issue a test ... one lock per device.
88 * tests create other threads if they need them.
89 * urbs and buffers are allocated dynamically,
90 * and data generated deterministically.
91 */
92struct usbtest_dev {
93 struct usb_interface *intf;
94 struct usbtest_info *info;
95 int in_pipe;
96 int out_pipe;
97 int in_iso_pipe;
98 int out_iso_pipe;
99 int in_int_pipe;
100 int out_int_pipe;
101 struct usb_endpoint_descriptor *iso_in, *iso_out;
102 struct usb_endpoint_descriptor *int_in, *int_out;
103 struct mutex lock;
104
105#define TBUF_SIZE 256
106 u8 *buf;
107};
108
109static struct usb_device *testdev_to_usbdev(struct usbtest_dev *test)
110{
111 return interface_to_usbdev(test->intf);
112}
113
114/* set up all urbs so they can be used with either bulk or interrupt */
115#define INTERRUPT_RATE 1 /* msec/transfer */
116
117#define ERROR(tdev, fmt, args...) \
118 dev_err(&(tdev)->intf->dev , fmt , ## args)
119#define WARNING(tdev, fmt, args...) \
120 dev_warn(&(tdev)->intf->dev , fmt , ## args)
121
122#define GUARD_BYTE 0xA5
123#define MAX_SGLEN 128
124
125/*-------------------------------------------------------------------------*/
126
127static int
128get_endpoints(struct usbtest_dev *dev, struct usb_interface *intf)
129{
130 int tmp;
131 struct usb_host_interface *alt;
132 struct usb_host_endpoint *in, *out;
133 struct usb_host_endpoint *iso_in, *iso_out;
134 struct usb_host_endpoint *int_in, *int_out;
135 struct usb_device *udev;
136
137 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
138 unsigned ep;
139
140 in = out = NULL;
141 iso_in = iso_out = NULL;
142 int_in = int_out = NULL;
143 alt = intf->altsetting + tmp;
144
145 if (override_alt >= 0 &&
146 override_alt != alt->desc.bAlternateSetting)
147 continue;
148
149 /* take the first altsetting with in-bulk + out-bulk;
150 * ignore other endpoints and altsettings.
151 */
152 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
153 struct usb_host_endpoint *e;
154
155 e = alt->endpoint + ep;
156 switch (usb_endpoint_type(&e->desc)) {
157 case USB_ENDPOINT_XFER_BULK:
158 break;
159 case USB_ENDPOINT_XFER_INT:
160 if (dev->info->intr)
161 goto try_intr;
162 case USB_ENDPOINT_XFER_ISOC:
163 if (dev->info->iso)
164 goto try_iso;
165 /* FALLTHROUGH */
166 default:
167 continue;
168 }
169 if (usb_endpoint_dir_in(&e->desc)) {
170 if (!in)
171 in = e;
172 } else {
173 if (!out)
174 out = e;
175 }
176 continue;
177try_intr:
178 if (usb_endpoint_dir_in(&e->desc)) {
179 if (!int_in)
180 int_in = e;
181 } else {
182 if (!int_out)
183 int_out = e;
184 }
185 continue;
186try_iso:
187 if (usb_endpoint_dir_in(&e->desc)) {
188 if (!iso_in)
189 iso_in = e;
190 } else {
191 if (!iso_out)
192 iso_out = e;
193 }
194 }
195 if ((in && out) || iso_in || iso_out || int_in || int_out)
196 goto found;
197 }
198 return -EINVAL;
199
200found:
201 udev = testdev_to_usbdev(dev);
202 dev->info->alt = alt->desc.bAlternateSetting;
203 if (alt->desc.bAlternateSetting != 0) {
204 tmp = usb_set_interface(udev,
205 alt->desc.bInterfaceNumber,
206 alt->desc.bAlternateSetting);
207 if (tmp < 0)
208 return tmp;
209 }
210
211 if (in) {
212 dev->in_pipe = usb_rcvbulkpipe(udev,
213 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
214 dev->out_pipe = usb_sndbulkpipe(udev,
215 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
216 }
217 if (iso_in) {
218 dev->iso_in = &iso_in->desc;
219 dev->in_iso_pipe = usb_rcvisocpipe(udev,
220 iso_in->desc.bEndpointAddress
221 & USB_ENDPOINT_NUMBER_MASK);
222 }
223
224 if (iso_out) {
225 dev->iso_out = &iso_out->desc;
226 dev->out_iso_pipe = usb_sndisocpipe(udev,
227 iso_out->desc.bEndpointAddress
228 & USB_ENDPOINT_NUMBER_MASK);
229 }
230
231 if (int_in) {
232 dev->int_in = &int_in->desc;
233 dev->in_int_pipe = usb_rcvintpipe(udev,
234 int_in->desc.bEndpointAddress
235 & USB_ENDPOINT_NUMBER_MASK);
236 }
237
238 if (int_out) {
239 dev->int_out = &int_out->desc;
240 dev->out_int_pipe = usb_sndintpipe(udev,
241 int_out->desc.bEndpointAddress
242 & USB_ENDPOINT_NUMBER_MASK);
243 }
244 return 0;
245}
246
247/*-------------------------------------------------------------------------*/
248
249/* Support for testing basic non-queued I/O streams.
250 *
251 * These just package urbs as requests that can be easily canceled.
252 * Each urb's data buffer is dynamically allocated; callers can fill
253 * them with non-zero test data (or test for it) when appropriate.
254 */
255
256static void simple_callback(struct urb *urb)
257{
258 complete(urb->context);
259}
260
261static struct urb *usbtest_alloc_urb(
262 struct usb_device *udev,
263 int pipe,
264 unsigned long bytes,
265 unsigned transfer_flags,
266 unsigned offset,
267 u8 bInterval,
268 usb_complete_t complete_fn)
269{
270 struct urb *urb;
271
272 urb = usb_alloc_urb(0, GFP_KERNEL);
273 if (!urb)
274 return urb;
275
276 if (bInterval)
277 usb_fill_int_urb(urb, udev, pipe, NULL, bytes, complete_fn,
278 NULL, bInterval);
279 else
280 usb_fill_bulk_urb(urb, udev, pipe, NULL, bytes, complete_fn,
281 NULL);
282
283 urb->interval = (udev->speed == USB_SPEED_HIGH)
284 ? (INTERRUPT_RATE << 3)
285 : INTERRUPT_RATE;
286 urb->transfer_flags = transfer_flags;
287 if (usb_pipein(pipe))
288 urb->transfer_flags |= URB_SHORT_NOT_OK;
289
290 if (urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
291 urb->transfer_buffer = usb_alloc_coherent(udev, bytes + offset,
292 GFP_KERNEL, &urb->transfer_dma);
293 else
294 urb->transfer_buffer = kmalloc(bytes + offset, GFP_KERNEL);
295
296 if (!urb->transfer_buffer) {
297 usb_free_urb(urb);
298 return NULL;
299 }
300
301 /* To test unaligned transfers add an offset and fill the
302 unused memory with a guard value */
303 if (offset) {
304 memset(urb->transfer_buffer, GUARD_BYTE, offset);
305 urb->transfer_buffer += offset;
306 if (urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
307 urb->transfer_dma += offset;
308 }
309
310 /* For inbound transfers use guard byte so that test fails if
311 data not correctly copied */
312 memset(urb->transfer_buffer,
313 usb_pipein(urb->pipe) ? GUARD_BYTE : 0,
314 bytes);
315 return urb;
316}
317
318static struct urb *simple_alloc_urb(
319 struct usb_device *udev,
320 int pipe,
321 unsigned long bytes,
322 u8 bInterval)
323{
324 return usbtest_alloc_urb(udev, pipe, bytes, URB_NO_TRANSFER_DMA_MAP, 0,
325 bInterval, simple_callback);
326}
327
328static struct urb *complicated_alloc_urb(
329 struct usb_device *udev,
330 int pipe,
331 unsigned long bytes,
332 u8 bInterval)
333{
334 return usbtest_alloc_urb(udev, pipe, bytes, URB_NO_TRANSFER_DMA_MAP, 0,
335 bInterval, complicated_callback);
336}
337
338static unsigned pattern;
339static unsigned mod_pattern;
340module_param_named(pattern, mod_pattern, uint, S_IRUGO | S_IWUSR);
341MODULE_PARM_DESC(mod_pattern, "i/o pattern (0 == zeroes)");
342
343static unsigned get_maxpacket(struct usb_device *udev, int pipe)
344{
345 struct usb_host_endpoint *ep;
346
347 ep = usb_pipe_endpoint(udev, pipe);
348 return le16_to_cpup(&ep->desc.wMaxPacketSize);
349}
350
351static void simple_fill_buf(struct urb *urb)
352{
353 unsigned i;
354 u8 *buf = urb->transfer_buffer;
355 unsigned len = urb->transfer_buffer_length;
356 unsigned maxpacket;
357
358 switch (pattern) {
359 default:
360 /* FALLTHROUGH */
361 case 0:
362 memset(buf, 0, len);
363 break;
364 case 1: /* mod63 */
365 maxpacket = get_maxpacket(urb->dev, urb->pipe);
366 for (i = 0; i < len; i++)
367 *buf++ = (u8) ((i % maxpacket) % 63);
368 break;
369 }
370}
371
372static inline unsigned long buffer_offset(void *buf)
373{
374 return (unsigned long)buf & (ARCH_KMALLOC_MINALIGN - 1);
375}
376
377static int check_guard_bytes(struct usbtest_dev *tdev, struct urb *urb)
378{
379 u8 *buf = urb->transfer_buffer;
380 u8 *guard = buf - buffer_offset(buf);
381 unsigned i;
382
383 for (i = 0; guard < buf; i++, guard++) {
384 if (*guard != GUARD_BYTE) {
385 ERROR(tdev, "guard byte[%d] %d (not %d)\n",
386 i, *guard, GUARD_BYTE);
387 return -EINVAL;
388 }
389 }
390 return 0;
391}
392
393static int simple_check_buf(struct usbtest_dev *tdev, struct urb *urb)
394{
395 unsigned i;
396 u8 expected;
397 u8 *buf = urb->transfer_buffer;
398 unsigned len = urb->actual_length;
399 unsigned maxpacket = get_maxpacket(urb->dev, urb->pipe);
400
401 int ret = check_guard_bytes(tdev, urb);
402 if (ret)
403 return ret;
404
405 for (i = 0; i < len; i++, buf++) {
406 switch (pattern) {
407 /* all-zeroes has no synchronization issues */
408 case 0:
409 expected = 0;
410 break;
411 /* mod63 stays in sync with short-terminated transfers,
412 * or otherwise when host and gadget agree on how large
413 * each usb transfer request should be. resync is done
414 * with set_interface or set_config.
415 */
416 case 1: /* mod63 */
417 expected = (i % maxpacket) % 63;
418 break;
419 /* always fail unsupported patterns */
420 default:
421 expected = !*buf;
422 break;
423 }
424 if (*buf == expected)
425 continue;
426 ERROR(tdev, "buf[%d] = %d (not %d)\n", i, *buf, expected);
427 return -EINVAL;
428 }
429 return 0;
430}
431
432static void simple_free_urb(struct urb *urb)
433{
434 unsigned long offset = buffer_offset(urb->transfer_buffer);
435
436 if (urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
437 usb_free_coherent(
438 urb->dev,
439 urb->transfer_buffer_length + offset,
440 urb->transfer_buffer - offset,
441 urb->transfer_dma - offset);
442 else
443 kfree(urb->transfer_buffer - offset);
444 usb_free_urb(urb);
445}
446
447static int simple_io(
448 struct usbtest_dev *tdev,
449 struct urb *urb,
450 int iterations,
451 int vary,
452 int expected,
453 const char *label
454)
455{
456 struct usb_device *udev = urb->dev;
457 int max = urb->transfer_buffer_length;
458 struct completion completion;
459 int retval = 0;
460 unsigned long expire;
461
462 urb->context = &completion;
463 while (retval == 0 && iterations-- > 0) {
464 init_completion(&completion);
465 if (usb_pipeout(urb->pipe)) {
466 simple_fill_buf(urb);
467 urb->transfer_flags |= URB_ZERO_PACKET;
468 }
469 retval = usb_submit_urb(urb, GFP_KERNEL);
470 if (retval != 0)
471 break;
472
473 expire = msecs_to_jiffies(SIMPLE_IO_TIMEOUT);
474 if (!wait_for_completion_timeout(&completion, expire)) {
475 usb_kill_urb(urb);
476 retval = (urb->status == -ENOENT ?
477 -ETIMEDOUT : urb->status);
478 } else {
479 retval = urb->status;
480 }
481
482 urb->dev = udev;
483 if (retval == 0 && usb_pipein(urb->pipe))
484 retval = simple_check_buf(tdev, urb);
485
486 if (vary) {
487 int len = urb->transfer_buffer_length;
488
489 len += vary;
490 len %= max;
491 if (len == 0)
492 len = (vary < max) ? vary : max;
493 urb->transfer_buffer_length = len;
494 }
495
496 /* FIXME if endpoint halted, clear halt (and log) */
497 }
498 urb->transfer_buffer_length = max;
499
500 if (expected != retval)
501 dev_err(&udev->dev,
502 "%s failed, iterations left %d, status %d (not %d)\n",
503 label, iterations, retval, expected);
504 return retval;
505}
506
507
508/*-------------------------------------------------------------------------*/
509
510/* We use scatterlist primitives to test queued I/O.
511 * Yes, this also tests the scatterlist primitives.
512 */
513
514static void free_sglist(struct scatterlist *sg, int nents)
515{
516 unsigned i;
517
518 if (!sg)
519 return;
520 for (i = 0; i < nents; i++) {
521 if (!sg_page(&sg[i]))
522 continue;
523 kfree(sg_virt(&sg[i]));
524 }
525 kfree(sg);
526}
527
528static struct scatterlist *
529alloc_sglist(int nents, int max, int vary, struct usbtest_dev *dev, int pipe)
530{
531 struct scatterlist *sg;
532 unsigned i;
533 unsigned size = max;
534 unsigned maxpacket =
535 get_maxpacket(interface_to_usbdev(dev->intf), pipe);
536
537 if (max == 0)
538 return NULL;
539
540 sg = kmalloc_array(nents, sizeof(*sg), GFP_KERNEL);
541 if (!sg)
542 return NULL;
543 sg_init_table(sg, nents);
544
545 for (i = 0; i < nents; i++) {
546 char *buf;
547 unsigned j;
548
549 buf = kzalloc(size, GFP_KERNEL);
550 if (!buf) {
551 free_sglist(sg, i);
552 return NULL;
553 }
554
555 /* kmalloc pages are always physically contiguous! */
556 sg_set_buf(&sg[i], buf, size);
557
558 switch (pattern) {
559 case 0:
560 /* already zeroed */
561 break;
562 case 1:
563 for (j = 0; j < size; j++)
564 *buf++ = (u8) ((j % maxpacket) % 63);
565 break;
566 }
567
568 if (vary) {
569 size += vary;
570 size %= max;
571 if (size == 0)
572 size = (vary < max) ? vary : max;
573 }
574 }
575
576 return sg;
577}
578
579static void sg_timeout(unsigned long _req)
580{
581 struct usb_sg_request *req = (struct usb_sg_request *) _req;
582
583 req->status = -ETIMEDOUT;
584 usb_sg_cancel(req);
585}
586
587static int perform_sglist(
588 struct usbtest_dev *tdev,
589 unsigned iterations,
590 int pipe,
591 struct usb_sg_request *req,
592 struct scatterlist *sg,
593 int nents
594)
595{
596 struct usb_device *udev = testdev_to_usbdev(tdev);
597 int retval = 0;
598 struct timer_list sg_timer;
599
600 setup_timer_on_stack(&sg_timer, sg_timeout, (unsigned long) req);
601
602 while (retval == 0 && iterations-- > 0) {
603 retval = usb_sg_init(req, udev, pipe,
604 (udev->speed == USB_SPEED_HIGH)
605 ? (INTERRUPT_RATE << 3)
606 : INTERRUPT_RATE,
607 sg, nents, 0, GFP_KERNEL);
608
609 if (retval)
610 break;
611 mod_timer(&sg_timer, jiffies +
612 msecs_to_jiffies(SIMPLE_IO_TIMEOUT));
613 usb_sg_wait(req);
614 del_timer_sync(&sg_timer);
615 retval = req->status;
616
617 /* FIXME check resulting data pattern */
618
619 /* FIXME if endpoint halted, clear halt (and log) */
620 }
621
622 /* FIXME for unlink or fault handling tests, don't report
623 * failure if retval is as we expected ...
624 */
625 if (retval)
626 ERROR(tdev, "perform_sglist failed, "
627 "iterations left %d, status %d\n",
628 iterations, retval);
629 return retval;
630}
631
632
633/*-------------------------------------------------------------------------*/
634
635/* unqueued control message testing
636 *
637 * there's a nice set of device functional requirements in chapter 9 of the
638 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
639 * special test firmware.
640 *
641 * we know the device is configured (or suspended) by the time it's visible
642 * through usbfs. we can't change that, so we won't test enumeration (which
643 * worked 'well enough' to get here, this time), power management (ditto),
644 * or remote wakeup (which needs human interaction).
645 */
646
647static unsigned realworld = 1;
648module_param(realworld, uint, 0);
649MODULE_PARM_DESC(realworld, "clear to demand stricter spec compliance");
650
651static int get_altsetting(struct usbtest_dev *dev)
652{
653 struct usb_interface *iface = dev->intf;
654 struct usb_device *udev = interface_to_usbdev(iface);
655 int retval;
656
657 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
658 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
659 0, iface->altsetting[0].desc.bInterfaceNumber,
660 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
661 switch (retval) {
662 case 1:
663 return dev->buf[0];
664 case 0:
665 retval = -ERANGE;
666 /* FALLTHROUGH */
667 default:
668 return retval;
669 }
670}
671
672static int set_altsetting(struct usbtest_dev *dev, int alternate)
673{
674 struct usb_interface *iface = dev->intf;
675 struct usb_device *udev;
676
677 if (alternate < 0 || alternate >= 256)
678 return -EINVAL;
679
680 udev = interface_to_usbdev(iface);
681 return usb_set_interface(udev,
682 iface->altsetting[0].desc.bInterfaceNumber,
683 alternate);
684}
685
686static int is_good_config(struct usbtest_dev *tdev, int len)
687{
688 struct usb_config_descriptor *config;
689
690 if (len < sizeof(*config))
691 return 0;
692 config = (struct usb_config_descriptor *) tdev->buf;
693
694 switch (config->bDescriptorType) {
695 case USB_DT_CONFIG:
696 case USB_DT_OTHER_SPEED_CONFIG:
697 if (config->bLength != 9) {
698 ERROR(tdev, "bogus config descriptor length\n");
699 return 0;
700 }
701 /* this bit 'must be 1' but often isn't */
702 if (!realworld && !(config->bmAttributes & 0x80)) {
703 ERROR(tdev, "high bit of config attributes not set\n");
704 return 0;
705 }
706 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
707 ERROR(tdev, "reserved config bits set\n");
708 return 0;
709 }
710 break;
711 default:
712 return 0;
713 }
714
715 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
716 return 1;
717 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
718 return 1;
719 ERROR(tdev, "bogus config descriptor read size\n");
720 return 0;
721}
722
723static int is_good_ext(struct usbtest_dev *tdev, u8 *buf)
724{
725 struct usb_ext_cap_descriptor *ext;
726 u32 attr;
727
728 ext = (struct usb_ext_cap_descriptor *) buf;
729
730 if (ext->bLength != USB_DT_USB_EXT_CAP_SIZE) {
731 ERROR(tdev, "bogus usb 2.0 extension descriptor length\n");
732 return 0;
733 }
734
735 attr = le32_to_cpu(ext->bmAttributes);
736 /* bits[1:15] is used and others are reserved */
737 if (attr & ~0xfffe) { /* reserved == 0 */
738 ERROR(tdev, "reserved bits set\n");
739 return 0;
740 }
741
742 return 1;
743}
744
745static int is_good_ss_cap(struct usbtest_dev *tdev, u8 *buf)
746{
747 struct usb_ss_cap_descriptor *ss;
748
749 ss = (struct usb_ss_cap_descriptor *) buf;
750
751 if (ss->bLength != USB_DT_USB_SS_CAP_SIZE) {
752 ERROR(tdev, "bogus superspeed device capability descriptor length\n");
753 return 0;
754 }
755
756 /*
757 * only bit[1] of bmAttributes is used for LTM and others are
758 * reserved
759 */
760 if (ss->bmAttributes & ~0x02) { /* reserved == 0 */
761 ERROR(tdev, "reserved bits set in bmAttributes\n");
762 return 0;
763 }
764
765 /* bits[0:3] of wSpeedSupported is used and others are reserved */
766 if (le16_to_cpu(ss->wSpeedSupported) & ~0x0f) { /* reserved == 0 */
767 ERROR(tdev, "reserved bits set in wSpeedSupported\n");
768 return 0;
769 }
770
771 return 1;
772}
773
774static int is_good_con_id(struct usbtest_dev *tdev, u8 *buf)
775{
776 struct usb_ss_container_id_descriptor *con_id;
777
778 con_id = (struct usb_ss_container_id_descriptor *) buf;
779
780 if (con_id->bLength != USB_DT_USB_SS_CONTN_ID_SIZE) {
781 ERROR(tdev, "bogus container id descriptor length\n");
782 return 0;
783 }
784
785 if (con_id->bReserved) { /* reserved == 0 */
786 ERROR(tdev, "reserved bits set\n");
787 return 0;
788 }
789
790 return 1;
791}
792
793/* sanity test for standard requests working with usb_control_mesg() and some
794 * of the utility functions which use it.
795 *
796 * this doesn't test how endpoint halts behave or data toggles get set, since
797 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
798 * halt or toggle). toggle testing is impractical without support from hcds.
799 *
800 * this avoids failing devices linux would normally work with, by not testing
801 * config/altsetting operations for devices that only support their defaults.
802 * such devices rarely support those needless operations.
803 *
804 * NOTE that since this is a sanity test, it's not examining boundary cases
805 * to see if usbcore, hcd, and device all behave right. such testing would
806 * involve varied read sizes and other operation sequences.
807 */
808static int ch9_postconfig(struct usbtest_dev *dev)
809{
810 struct usb_interface *iface = dev->intf;
811 struct usb_device *udev = interface_to_usbdev(iface);
812 int i, alt, retval;
813
814 /* [9.2.3] if there's more than one altsetting, we need to be able to
815 * set and get each one. mostly trusts the descriptors from usbcore.
816 */
817 for (i = 0; i < iface->num_altsetting; i++) {
818
819 /* 9.2.3 constrains the range here */
820 alt = iface->altsetting[i].desc.bAlternateSetting;
821 if (alt < 0 || alt >= iface->num_altsetting) {
822 dev_err(&iface->dev,
823 "invalid alt [%d].bAltSetting = %d\n",
824 i, alt);
825 }
826
827 /* [real world] get/set unimplemented if there's only one */
828 if (realworld && iface->num_altsetting == 1)
829 continue;
830
831 /* [9.4.10] set_interface */
832 retval = set_altsetting(dev, alt);
833 if (retval) {
834 dev_err(&iface->dev, "can't set_interface = %d, %d\n",
835 alt, retval);
836 return retval;
837 }
838
839 /* [9.4.4] get_interface always works */
840 retval = get_altsetting(dev);
841 if (retval != alt) {
842 dev_err(&iface->dev, "get alt should be %d, was %d\n",
843 alt, retval);
844 return (retval < 0) ? retval : -EDOM;
845 }
846
847 }
848
849 /* [real world] get_config unimplemented if there's only one */
850 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
851 int expected = udev->actconfig->desc.bConfigurationValue;
852
853 /* [9.4.2] get_configuration always works
854 * ... although some cheap devices (like one TI Hub I've got)
855 * won't return config descriptors except before set_config.
856 */
857 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
858 USB_REQ_GET_CONFIGURATION,
859 USB_DIR_IN | USB_RECIP_DEVICE,
860 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
861 if (retval != 1 || dev->buf[0] != expected) {
862 dev_err(&iface->dev, "get config --> %d %d (1 %d)\n",
863 retval, dev->buf[0], expected);
864 return (retval < 0) ? retval : -EDOM;
865 }
866 }
867
868 /* there's always [9.4.3] a device descriptor [9.6.1] */
869 retval = usb_get_descriptor(udev, USB_DT_DEVICE, 0,
870 dev->buf, sizeof(udev->descriptor));
871 if (retval != sizeof(udev->descriptor)) {
872 dev_err(&iface->dev, "dev descriptor --> %d\n", retval);
873 return (retval < 0) ? retval : -EDOM;
874 }
875
876 /*
877 * there's always [9.4.3] a bos device descriptor [9.6.2] in USB
878 * 3.0 spec
879 */
880 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0210) {
881 struct usb_bos_descriptor *bos = NULL;
882 struct usb_dev_cap_header *header = NULL;
883 unsigned total, num, length;
884 u8 *buf;
885
886 retval = usb_get_descriptor(udev, USB_DT_BOS, 0, dev->buf,
887 sizeof(*udev->bos->desc));
888 if (retval != sizeof(*udev->bos->desc)) {
889 dev_err(&iface->dev, "bos descriptor --> %d\n", retval);
890 return (retval < 0) ? retval : -EDOM;
891 }
892
893 bos = (struct usb_bos_descriptor *)dev->buf;
894 total = le16_to_cpu(bos->wTotalLength);
895 num = bos->bNumDeviceCaps;
896
897 if (total > TBUF_SIZE)
898 total = TBUF_SIZE;
899
900 /*
901 * get generic device-level capability descriptors [9.6.2]
902 * in USB 3.0 spec
903 */
904 retval = usb_get_descriptor(udev, USB_DT_BOS, 0, dev->buf,
905 total);
906 if (retval != total) {
907 dev_err(&iface->dev, "bos descriptor set --> %d\n",
908 retval);
909 return (retval < 0) ? retval : -EDOM;
910 }
911
912 length = sizeof(*udev->bos->desc);
913 buf = dev->buf;
914 for (i = 0; i < num; i++) {
915 buf += length;
916 if (buf + sizeof(struct usb_dev_cap_header) >
917 dev->buf + total)
918 break;
919
920 header = (struct usb_dev_cap_header *)buf;
921 length = header->bLength;
922
923 if (header->bDescriptorType !=
924 USB_DT_DEVICE_CAPABILITY) {
925 dev_warn(&udev->dev, "not device capability descriptor, skip\n");
926 continue;
927 }
928
929 switch (header->bDevCapabilityType) {
930 case USB_CAP_TYPE_EXT:
931 if (buf + USB_DT_USB_EXT_CAP_SIZE >
932 dev->buf + total ||
933 !is_good_ext(dev, buf)) {
934 dev_err(&iface->dev, "bogus usb 2.0 extension descriptor\n");
935 return -EDOM;
936 }
937 break;
938 case USB_SS_CAP_TYPE:
939 if (buf + USB_DT_USB_SS_CAP_SIZE >
940 dev->buf + total ||
941 !is_good_ss_cap(dev, buf)) {
942 dev_err(&iface->dev, "bogus superspeed device capability descriptor\n");
943 return -EDOM;
944 }
945 break;
946 case CONTAINER_ID_TYPE:
947 if (buf + USB_DT_USB_SS_CONTN_ID_SIZE >
948 dev->buf + total ||
949 !is_good_con_id(dev, buf)) {
950 dev_err(&iface->dev, "bogus container id descriptor\n");
951 return -EDOM;
952 }
953 break;
954 default:
955 break;
956 }
957 }
958 }
959
960 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
961 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
962 retval = usb_get_descriptor(udev, USB_DT_CONFIG, i,
963 dev->buf, TBUF_SIZE);
964 if (!is_good_config(dev, retval)) {
965 dev_err(&iface->dev,
966 "config [%d] descriptor --> %d\n",
967 i, retval);
968 return (retval < 0) ? retval : -EDOM;
969 }
970
971 /* FIXME cross-checking udev->config[i] to make sure usbcore
972 * parsed it right (etc) would be good testing paranoia
973 */
974 }
975
976 /* and sometimes [9.2.6.6] speed dependent descriptors */
977 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
978 struct usb_qualifier_descriptor *d = NULL;
979
980 /* device qualifier [9.6.2] */
981 retval = usb_get_descriptor(udev,
982 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
983 sizeof(struct usb_qualifier_descriptor));
984 if (retval == -EPIPE) {
985 if (udev->speed == USB_SPEED_HIGH) {
986 dev_err(&iface->dev,
987 "hs dev qualifier --> %d\n",
988 retval);
989 return (retval < 0) ? retval : -EDOM;
990 }
991 /* usb2.0 but not high-speed capable; fine */
992 } else if (retval != sizeof(struct usb_qualifier_descriptor)) {
993 dev_err(&iface->dev, "dev qualifier --> %d\n", retval);
994 return (retval < 0) ? retval : -EDOM;
995 } else
996 d = (struct usb_qualifier_descriptor *) dev->buf;
997
998 /* might not have [9.6.2] any other-speed configs [9.6.4] */
999 if (d) {
1000 unsigned max = d->bNumConfigurations;
1001 for (i = 0; i < max; i++) {
1002 retval = usb_get_descriptor(udev,
1003 USB_DT_OTHER_SPEED_CONFIG, i,
1004 dev->buf, TBUF_SIZE);
1005 if (!is_good_config(dev, retval)) {
1006 dev_err(&iface->dev,
1007 "other speed config --> %d\n",
1008 retval);
1009 return (retval < 0) ? retval : -EDOM;
1010 }
1011 }
1012 }
1013 }
1014 /* FIXME fetch strings from at least the device descriptor */
1015
1016 /* [9.4.5] get_status always works */
1017 retval = usb_get_status(udev, USB_RECIP_DEVICE, 0, dev->buf);
1018 if (retval) {
1019 dev_err(&iface->dev, "get dev status --> %d\n", retval);
1020 return retval;
1021 }
1022
1023 /* FIXME configuration.bmAttributes says if we could try to set/clear
1024 * the device's remote wakeup feature ... if we can, test that here
1025 */
1026
1027 retval = usb_get_status(udev, USB_RECIP_INTERFACE,
1028 iface->altsetting[0].desc.bInterfaceNumber, dev->buf);
1029 if (retval) {
1030 dev_err(&iface->dev, "get interface status --> %d\n", retval);
1031 return retval;
1032 }
1033 /* FIXME get status for each endpoint in the interface */
1034
1035 return 0;
1036}
1037
1038/*-------------------------------------------------------------------------*/
1039
1040/* use ch9 requests to test whether:
1041 * (a) queues work for control, keeping N subtests queued and
1042 * active (auto-resubmit) for M loops through the queue.
1043 * (b) protocol stalls (control-only) will autorecover.
1044 * it's not like bulk/intr; no halt clearing.
1045 * (c) short control reads are reported and handled.
1046 * (d) queues are always processed in-order
1047 */
1048
1049struct ctrl_ctx {
1050 spinlock_t lock;
1051 struct usbtest_dev *dev;
1052 struct completion complete;
1053 unsigned count;
1054 unsigned pending;
1055 int status;
1056 struct urb **urb;
1057 struct usbtest_param_32 *param;
1058 int last;
1059};
1060
1061#define NUM_SUBCASES 16 /* how many test subcases here? */
1062
1063struct subcase {
1064 struct usb_ctrlrequest setup;
1065 int number;
1066 int expected;
1067};
1068
1069static void ctrl_complete(struct urb *urb)
1070{
1071 struct ctrl_ctx *ctx = urb->context;
1072 struct usb_ctrlrequest *reqp;
1073 struct subcase *subcase;
1074 int status = urb->status;
1075
1076 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
1077 subcase = container_of(reqp, struct subcase, setup);
1078
1079 spin_lock(&ctx->lock);
1080 ctx->count--;
1081 ctx->pending--;
1082
1083 /* queue must transfer and complete in fifo order, unless
1084 * usb_unlink_urb() is used to unlink something not at the
1085 * physical queue head (not tested).
1086 */
1087 if (subcase->number > 0) {
1088 if ((subcase->number - ctx->last) != 1) {
1089 ERROR(ctx->dev,
1090 "subcase %d completed out of order, last %d\n",
1091 subcase->number, ctx->last);
1092 status = -EDOM;
1093 ctx->last = subcase->number;
1094 goto error;
1095 }
1096 }
1097 ctx->last = subcase->number;
1098
1099 /* succeed or fault in only one way? */
1100 if (status == subcase->expected)
1101 status = 0;
1102
1103 /* async unlink for cleanup? */
1104 else if (status != -ECONNRESET) {
1105
1106 /* some faults are allowed, not required */
1107 if (subcase->expected > 0 && (
1108 ((status == -subcase->expected /* happened */
1109 || status == 0)))) /* didn't */
1110 status = 0;
1111 /* sometimes more than one fault is allowed */
1112 else if (subcase->number == 12 && status == -EPIPE)
1113 status = 0;
1114 else
1115 ERROR(ctx->dev, "subtest %d error, status %d\n",
1116 subcase->number, status);
1117 }
1118
1119 /* unexpected status codes mean errors; ideally, in hardware */
1120 if (status) {
1121error:
1122 if (ctx->status == 0) {
1123 int i;
1124
1125 ctx->status = status;
1126 ERROR(ctx->dev, "control queue %02x.%02x, err %d, "
1127 "%d left, subcase %d, len %d/%d\n",
1128 reqp->bRequestType, reqp->bRequest,
1129 status, ctx->count, subcase->number,
1130 urb->actual_length,
1131 urb->transfer_buffer_length);
1132
1133 /* FIXME this "unlink everything" exit route should
1134 * be a separate test case.
1135 */
1136
1137 /* unlink whatever's still pending */
1138 for (i = 1; i < ctx->param->sglen; i++) {
1139 struct urb *u = ctx->urb[
1140 (i + subcase->number)
1141 % ctx->param->sglen];
1142
1143 if (u == urb || !u->dev)
1144 continue;
1145 spin_unlock(&ctx->lock);
1146 status = usb_unlink_urb(u);
1147 spin_lock(&ctx->lock);
1148 switch (status) {
1149 case -EINPROGRESS:
1150 case -EBUSY:
1151 case -EIDRM:
1152 continue;
1153 default:
1154 ERROR(ctx->dev, "urb unlink --> %d\n",
1155 status);
1156 }
1157 }
1158 status = ctx->status;
1159 }
1160 }
1161
1162 /* resubmit if we need to, else mark this as done */
1163 if ((status == 0) && (ctx->pending < ctx->count)) {
1164 status = usb_submit_urb(urb, GFP_ATOMIC);
1165 if (status != 0) {
1166 ERROR(ctx->dev,
1167 "can't resubmit ctrl %02x.%02x, err %d\n",
1168 reqp->bRequestType, reqp->bRequest, status);
1169 urb->dev = NULL;
1170 } else
1171 ctx->pending++;
1172 } else
1173 urb->dev = NULL;
1174
1175 /* signal completion when nothing's queued */
1176 if (ctx->pending == 0)
1177 complete(&ctx->complete);
1178 spin_unlock(&ctx->lock);
1179}
1180
1181static int
1182test_ctrl_queue(struct usbtest_dev *dev, struct usbtest_param_32 *param)
1183{
1184 struct usb_device *udev = testdev_to_usbdev(dev);
1185 struct urb **urb;
1186 struct ctrl_ctx context;
1187 int i;
1188
1189 if (param->sglen == 0 || param->iterations > UINT_MAX / param->sglen)
1190 return -EOPNOTSUPP;
1191
1192 spin_lock_init(&context.lock);
1193 context.dev = dev;
1194 init_completion(&context.complete);
1195 context.count = param->sglen * param->iterations;
1196 context.pending = 0;
1197 context.status = -ENOMEM;
1198 context.param = param;
1199 context.last = -1;
1200
1201 /* allocate and init the urbs we'll queue.
1202 * as with bulk/intr sglists, sglen is the queue depth; it also
1203 * controls which subtests run (more tests than sglen) or rerun.
1204 */
1205 urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
1206 if (!urb)
1207 return -ENOMEM;
1208 for (i = 0; i < param->sglen; i++) {
1209 int pipe = usb_rcvctrlpipe(udev, 0);
1210 unsigned len;
1211 struct urb *u;
1212 struct usb_ctrlrequest req;
1213 struct subcase *reqp;
1214
1215 /* sign of this variable means:
1216 * -: tested code must return this (negative) error code
1217 * +: tested code may return this (negative too) error code
1218 */
1219 int expected = 0;
1220
1221 /* requests here are mostly expected to succeed on any
1222 * device, but some are chosen to trigger protocol stalls
1223 * or short reads.
1224 */
1225 memset(&req, 0, sizeof(req));
1226 req.bRequest = USB_REQ_GET_DESCRIPTOR;
1227 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
1228
1229 switch (i % NUM_SUBCASES) {
1230 case 0: /* get device descriptor */
1231 req.wValue = cpu_to_le16(USB_DT_DEVICE << 8);
1232 len = sizeof(struct usb_device_descriptor);
1233 break;
1234 case 1: /* get first config descriptor (only) */
1235 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1236 len = sizeof(struct usb_config_descriptor);
1237 break;
1238 case 2: /* get altsetting (OFTEN STALLS) */
1239 req.bRequest = USB_REQ_GET_INTERFACE;
1240 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
1241 /* index = 0 means first interface */
1242 len = 1;
1243 expected = EPIPE;
1244 break;
1245 case 3: /* get interface status */
1246 req.bRequest = USB_REQ_GET_STATUS;
1247 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
1248 /* interface 0 */
1249 len = 2;
1250 break;
1251 case 4: /* get device status */
1252 req.bRequest = USB_REQ_GET_STATUS;
1253 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
1254 len = 2;
1255 break;
1256 case 5: /* get device qualifier (MAY STALL) */
1257 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
1258 len = sizeof(struct usb_qualifier_descriptor);
1259 if (udev->speed != USB_SPEED_HIGH)
1260 expected = EPIPE;
1261 break;
1262 case 6: /* get first config descriptor, plus interface */
1263 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1264 len = sizeof(struct usb_config_descriptor);
1265 len += sizeof(struct usb_interface_descriptor);
1266 break;
1267 case 7: /* get interface descriptor (ALWAYS STALLS) */
1268 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
1269 /* interface == 0 */
1270 len = sizeof(struct usb_interface_descriptor);
1271 expected = -EPIPE;
1272 break;
1273 /* NOTE: two consecutive stalls in the queue here.
1274 * that tests fault recovery a bit more aggressively. */
1275 case 8: /* clear endpoint halt (MAY STALL) */
1276 req.bRequest = USB_REQ_CLEAR_FEATURE;
1277 req.bRequestType = USB_RECIP_ENDPOINT;
1278 /* wValue 0 == ep halt */
1279 /* wIndex 0 == ep0 (shouldn't halt!) */
1280 len = 0;
1281 pipe = usb_sndctrlpipe(udev, 0);
1282 expected = EPIPE;
1283 break;
1284 case 9: /* get endpoint status */
1285 req.bRequest = USB_REQ_GET_STATUS;
1286 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
1287 /* endpoint 0 */
1288 len = 2;
1289 break;
1290 case 10: /* trigger short read (EREMOTEIO) */
1291 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1292 len = 1024;
1293 expected = -EREMOTEIO;
1294 break;
1295 /* NOTE: two consecutive _different_ faults in the queue. */
1296 case 11: /* get endpoint descriptor (ALWAYS STALLS) */
1297 req.wValue = cpu_to_le16(USB_DT_ENDPOINT << 8);
1298 /* endpoint == 0 */
1299 len = sizeof(struct usb_interface_descriptor);
1300 expected = EPIPE;
1301 break;
1302 /* NOTE: sometimes even a third fault in the queue! */
1303 case 12: /* get string 0 descriptor (MAY STALL) */
1304 req.wValue = cpu_to_le16(USB_DT_STRING << 8);
1305 /* string == 0, for language IDs */
1306 len = sizeof(struct usb_interface_descriptor);
1307 /* may succeed when > 4 languages */
1308 expected = EREMOTEIO; /* or EPIPE, if no strings */
1309 break;
1310 case 13: /* short read, resembling case 10 */
1311 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1312 /* last data packet "should" be DATA1, not DATA0 */
1313 if (udev->speed == USB_SPEED_SUPER)
1314 len = 1024 - 512;
1315 else
1316 len = 1024 - udev->descriptor.bMaxPacketSize0;
1317 expected = -EREMOTEIO;
1318 break;
1319 case 14: /* short read; try to fill the last packet */
1320 req.wValue = cpu_to_le16((USB_DT_DEVICE << 8) | 0);
1321 /* device descriptor size == 18 bytes */
1322 len = udev->descriptor.bMaxPacketSize0;
1323 if (udev->speed == USB_SPEED_SUPER)
1324 len = 512;
1325 switch (len) {
1326 case 8:
1327 len = 24;
1328 break;
1329 case 16:
1330 len = 32;
1331 break;
1332 }
1333 expected = -EREMOTEIO;
1334 break;
1335 case 15:
1336 req.wValue = cpu_to_le16(USB_DT_BOS << 8);
1337 if (udev->bos)
1338 len = le16_to_cpu(udev->bos->desc->wTotalLength);
1339 else
1340 len = sizeof(struct usb_bos_descriptor);
1341 if (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0201)
1342 expected = -EPIPE;
1343 break;
1344 default:
1345 ERROR(dev, "bogus number of ctrl queue testcases!\n");
1346 context.status = -EINVAL;
1347 goto cleanup;
1348 }
1349 req.wLength = cpu_to_le16(len);
1350 urb[i] = u = simple_alloc_urb(udev, pipe, len, 0);
1351 if (!u)
1352 goto cleanup;
1353
1354 reqp = kmalloc(sizeof(*reqp), GFP_KERNEL);
1355 if (!reqp)
1356 goto cleanup;
1357 reqp->setup = req;
1358 reqp->number = i % NUM_SUBCASES;
1359 reqp->expected = expected;
1360 u->setup_packet = (char *) &reqp->setup;
1361
1362 u->context = &context;
1363 u->complete = ctrl_complete;
1364 }
1365
1366 /* queue the urbs */
1367 context.urb = urb;
1368 spin_lock_irq(&context.lock);
1369 for (i = 0; i < param->sglen; i++) {
1370 context.status = usb_submit_urb(urb[i], GFP_ATOMIC);
1371 if (context.status != 0) {
1372 ERROR(dev, "can't submit urb[%d], status %d\n",
1373 i, context.status);
1374 context.count = context.pending;
1375 break;
1376 }
1377 context.pending++;
1378 }
1379 spin_unlock_irq(&context.lock);
1380
1381 /* FIXME set timer and time out; provide a disconnect hook */
1382
1383 /* wait for the last one to complete */
1384 if (context.pending > 0)
1385 wait_for_completion(&context.complete);
1386
1387cleanup:
1388 for (i = 0; i < param->sglen; i++) {
1389 if (!urb[i])
1390 continue;
1391 urb[i]->dev = udev;
1392 kfree(urb[i]->setup_packet);
1393 simple_free_urb(urb[i]);
1394 }
1395 kfree(urb);
1396 return context.status;
1397}
1398#undef NUM_SUBCASES
1399
1400
1401/*-------------------------------------------------------------------------*/
1402
1403static void unlink1_callback(struct urb *urb)
1404{
1405 int status = urb->status;
1406
1407 /* we "know" -EPIPE (stall) never happens */
1408 if (!status)
1409 status = usb_submit_urb(urb, GFP_ATOMIC);
1410 if (status) {
1411 urb->status = status;
1412 complete(urb->context);
1413 }
1414}
1415
1416static int unlink1(struct usbtest_dev *dev, int pipe, int size, int async)
1417{
1418 struct urb *urb;
1419 struct completion completion;
1420 int retval = 0;
1421
1422 init_completion(&completion);
1423 urb = simple_alloc_urb(testdev_to_usbdev(dev), pipe, size, 0);
1424 if (!urb)
1425 return -ENOMEM;
1426 urb->context = &completion;
1427 urb->complete = unlink1_callback;
1428
1429 if (usb_pipeout(urb->pipe)) {
1430 simple_fill_buf(urb);
1431 urb->transfer_flags |= URB_ZERO_PACKET;
1432 }
1433
1434 /* keep the endpoint busy. there are lots of hc/hcd-internal
1435 * states, and testing should get to all of them over time.
1436 *
1437 * FIXME want additional tests for when endpoint is STALLing
1438 * due to errors, or is just NAKing requests.
1439 */
1440 retval = usb_submit_urb(urb, GFP_KERNEL);
1441 if (retval != 0) {
1442 dev_err(&dev->intf->dev, "submit fail %d\n", retval);
1443 return retval;
1444 }
1445
1446 /* unlinking that should always work. variable delay tests more
1447 * hcd states and code paths, even with little other system load.
1448 */
1449 msleep(jiffies % (2 * INTERRUPT_RATE));
1450 if (async) {
1451 while (!completion_done(&completion)) {
1452 retval = usb_unlink_urb(urb);
1453
1454 if (retval == 0 && usb_pipein(urb->pipe))
1455 retval = simple_check_buf(dev, urb);
1456
1457 switch (retval) {
1458 case -EBUSY:
1459 case -EIDRM:
1460 /* we can't unlink urbs while they're completing
1461 * or if they've completed, and we haven't
1462 * resubmitted. "normal" drivers would prevent
1463 * resubmission, but since we're testing unlink
1464 * paths, we can't.
1465 */
1466 ERROR(dev, "unlink retry\n");
1467 continue;
1468 case 0:
1469 case -EINPROGRESS:
1470 break;
1471
1472 default:
1473 dev_err(&dev->intf->dev,
1474 "unlink fail %d\n", retval);
1475 return retval;
1476 }
1477
1478 break;
1479 }
1480 } else
1481 usb_kill_urb(urb);
1482
1483 wait_for_completion(&completion);
1484 retval = urb->status;
1485 simple_free_urb(urb);
1486
1487 if (async)
1488 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1489 else
1490 return (retval == -ENOENT || retval == -EPERM) ?
1491 0 : retval - 2000;
1492}
1493
1494static int unlink_simple(struct usbtest_dev *dev, int pipe, int len)
1495{
1496 int retval = 0;
1497
1498 /* test sync and async paths */
1499 retval = unlink1(dev, pipe, len, 1);
1500 if (!retval)
1501 retval = unlink1(dev, pipe, len, 0);
1502 return retval;
1503}
1504
1505/*-------------------------------------------------------------------------*/
1506
1507struct queued_ctx {
1508 struct completion complete;
1509 atomic_t pending;
1510 unsigned num;
1511 int status;
1512 struct urb **urbs;
1513};
1514
1515static void unlink_queued_callback(struct urb *urb)
1516{
1517 int status = urb->status;
1518 struct queued_ctx *ctx = urb->context;
1519
1520 if (ctx->status)
1521 goto done;
1522 if (urb == ctx->urbs[ctx->num - 4] || urb == ctx->urbs[ctx->num - 2]) {
1523 if (status == -ECONNRESET)
1524 goto done;
1525 /* What error should we report if the URB completed normally? */
1526 }
1527 if (status != 0)
1528 ctx->status = status;
1529
1530 done:
1531 if (atomic_dec_and_test(&ctx->pending))
1532 complete(&ctx->complete);
1533}
1534
1535static int unlink_queued(struct usbtest_dev *dev, int pipe, unsigned num,
1536 unsigned size)
1537{
1538 struct queued_ctx ctx;
1539 struct usb_device *udev = testdev_to_usbdev(dev);
1540 void *buf;
1541 dma_addr_t buf_dma;
1542 int i;
1543 int retval = -ENOMEM;
1544
1545 init_completion(&ctx.complete);
1546 atomic_set(&ctx.pending, 1); /* One more than the actual value */
1547 ctx.num = num;
1548 ctx.status = 0;
1549
1550 buf = usb_alloc_coherent(udev, size, GFP_KERNEL, &buf_dma);
1551 if (!buf)
1552 return retval;
1553 memset(buf, 0, size);
1554
1555 /* Allocate and init the urbs we'll queue */
1556 ctx.urbs = kcalloc(num, sizeof(struct urb *), GFP_KERNEL);
1557 if (!ctx.urbs)
1558 goto free_buf;
1559 for (i = 0; i < num; i++) {
1560 ctx.urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
1561 if (!ctx.urbs[i])
1562 goto free_urbs;
1563 usb_fill_bulk_urb(ctx.urbs[i], udev, pipe, buf, size,
1564 unlink_queued_callback, &ctx);
1565 ctx.urbs[i]->transfer_dma = buf_dma;
1566 ctx.urbs[i]->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1567
1568 if (usb_pipeout(ctx.urbs[i]->pipe)) {
1569 simple_fill_buf(ctx.urbs[i]);
1570 ctx.urbs[i]->transfer_flags |= URB_ZERO_PACKET;
1571 }
1572 }
1573
1574 /* Submit all the URBs and then unlink URBs num - 4 and num - 2. */
1575 for (i = 0; i < num; i++) {
1576 atomic_inc(&ctx.pending);
1577 retval = usb_submit_urb(ctx.urbs[i], GFP_KERNEL);
1578 if (retval != 0) {
1579 dev_err(&dev->intf->dev, "submit urbs[%d] fail %d\n",
1580 i, retval);
1581 atomic_dec(&ctx.pending);
1582 ctx.status = retval;
1583 break;
1584 }
1585 }
1586 if (i == num) {
1587 usb_unlink_urb(ctx.urbs[num - 4]);
1588 usb_unlink_urb(ctx.urbs[num - 2]);
1589 } else {
1590 while (--i >= 0)
1591 usb_unlink_urb(ctx.urbs[i]);
1592 }
1593
1594 if (atomic_dec_and_test(&ctx.pending)) /* The extra count */
1595 complete(&ctx.complete);
1596 wait_for_completion(&ctx.complete);
1597 retval = ctx.status;
1598
1599 free_urbs:
1600 for (i = 0; i < num; i++)
1601 usb_free_urb(ctx.urbs[i]);
1602 kfree(ctx.urbs);
1603 free_buf:
1604 usb_free_coherent(udev, size, buf, buf_dma);
1605 return retval;
1606}
1607
1608/*-------------------------------------------------------------------------*/
1609
1610static int verify_not_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1611{
1612 int retval;
1613 u16 status;
1614
1615 /* shouldn't look or act halted */
1616 retval = usb_get_status(urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1617 if (retval < 0) {
1618 ERROR(tdev, "ep %02x couldn't get no-halt status, %d\n",
1619 ep, retval);
1620 return retval;
1621 }
1622 if (status != 0) {
1623 ERROR(tdev, "ep %02x bogus status: %04x != 0\n", ep, status);
1624 return -EINVAL;
1625 }
1626 retval = simple_io(tdev, urb, 1, 0, 0, __func__);
1627 if (retval != 0)
1628 return -EINVAL;
1629 return 0;
1630}
1631
1632static int verify_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1633{
1634 int retval;
1635 u16 status;
1636
1637 /* should look and act halted */
1638 retval = usb_get_status(urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1639 if (retval < 0) {
1640 ERROR(tdev, "ep %02x couldn't get halt status, %d\n",
1641 ep, retval);
1642 return retval;
1643 }
1644 if (status != 1) {
1645 ERROR(tdev, "ep %02x bogus status: %04x != 1\n", ep, status);
1646 return -EINVAL;
1647 }
1648 retval = simple_io(tdev, urb, 1, 0, -EPIPE, __func__);
1649 if (retval != -EPIPE)
1650 return -EINVAL;
1651 retval = simple_io(tdev, urb, 1, 0, -EPIPE, "verify_still_halted");
1652 if (retval != -EPIPE)
1653 return -EINVAL;
1654 return 0;
1655}
1656
1657static int test_halt(struct usbtest_dev *tdev, int ep, struct urb *urb)
1658{
1659 int retval;
1660
1661 /* shouldn't look or act halted now */
1662 retval = verify_not_halted(tdev, ep, urb);
1663 if (retval < 0)
1664 return retval;
1665
1666 /* set halt (protocol test only), verify it worked */
1667 retval = usb_control_msg(urb->dev, usb_sndctrlpipe(urb->dev, 0),
1668 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1669 USB_ENDPOINT_HALT, ep,
1670 NULL, 0, USB_CTRL_SET_TIMEOUT);
1671 if (retval < 0) {
1672 ERROR(tdev, "ep %02x couldn't set halt, %d\n", ep, retval);
1673 return retval;
1674 }
1675 retval = verify_halted(tdev, ep, urb);
1676 if (retval < 0) {
1677 int ret;
1678
1679 /* clear halt anyways, else further tests will fail */
1680 ret = usb_clear_halt(urb->dev, urb->pipe);
1681 if (ret)
1682 ERROR(tdev, "ep %02x couldn't clear halt, %d\n",
1683 ep, ret);
1684
1685 return retval;
1686 }
1687
1688 /* clear halt (tests API + protocol), verify it worked */
1689 retval = usb_clear_halt(urb->dev, urb->pipe);
1690 if (retval < 0) {
1691 ERROR(tdev, "ep %02x couldn't clear halt, %d\n", ep, retval);
1692 return retval;
1693 }
1694 retval = verify_not_halted(tdev, ep, urb);
1695 if (retval < 0)
1696 return retval;
1697
1698 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1699
1700 return 0;
1701}
1702
1703static int halt_simple(struct usbtest_dev *dev)
1704{
1705 int ep;
1706 int retval = 0;
1707 struct urb *urb;
1708 struct usb_device *udev = testdev_to_usbdev(dev);
1709
1710 if (udev->speed == USB_SPEED_SUPER)
1711 urb = simple_alloc_urb(udev, 0, 1024, 0);
1712 else
1713 urb = simple_alloc_urb(udev, 0, 512, 0);
1714 if (urb == NULL)
1715 return -ENOMEM;
1716
1717 if (dev->in_pipe) {
1718 ep = usb_pipeendpoint(dev->in_pipe) | USB_DIR_IN;
1719 urb->pipe = dev->in_pipe;
1720 retval = test_halt(dev, ep, urb);
1721 if (retval < 0)
1722 goto done;
1723 }
1724
1725 if (dev->out_pipe) {
1726 ep = usb_pipeendpoint(dev->out_pipe);
1727 urb->pipe = dev->out_pipe;
1728 retval = test_halt(dev, ep, urb);
1729 }
1730done:
1731 simple_free_urb(urb);
1732 return retval;
1733}
1734
1735/*-------------------------------------------------------------------------*/
1736
1737/* Control OUT tests use the vendor control requests from Intel's
1738 * USB 2.0 compliance test device: write a buffer, read it back.
1739 *
1740 * Intel's spec only _requires_ that it work for one packet, which
1741 * is pretty weak. Some HCDs place limits here; most devices will
1742 * need to be able to handle more than one OUT data packet. We'll
1743 * try whatever we're told to try.
1744 */
1745static int ctrl_out(struct usbtest_dev *dev,
1746 unsigned count, unsigned length, unsigned vary, unsigned offset)
1747{
1748 unsigned i, j, len;
1749 int retval;
1750 u8 *buf;
1751 char *what = "?";
1752 struct usb_device *udev;
1753
1754 if (length < 1 || length > 0xffff || vary >= length)
1755 return -EINVAL;
1756
1757 buf = kmalloc(length + offset, GFP_KERNEL);
1758 if (!buf)
1759 return -ENOMEM;
1760
1761 buf += offset;
1762 udev = testdev_to_usbdev(dev);
1763 len = length;
1764 retval = 0;
1765
1766 /* NOTE: hardware might well act differently if we pushed it
1767 * with lots back-to-back queued requests.
1768 */
1769 for (i = 0; i < count; i++) {
1770 /* write patterned data */
1771 for (j = 0; j < len; j++)
1772 buf[j] = (u8)(i + j);
1773 retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1774 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1775 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1776 if (retval != len) {
1777 what = "write";
1778 if (retval >= 0) {
1779 ERROR(dev, "ctrl_out, wlen %d (expected %d)\n",
1780 retval, len);
1781 retval = -EBADMSG;
1782 }
1783 break;
1784 }
1785
1786 /* read it back -- assuming nothing intervened!! */
1787 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
1788 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1789 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1790 if (retval != len) {
1791 what = "read";
1792 if (retval >= 0) {
1793 ERROR(dev, "ctrl_out, rlen %d (expected %d)\n",
1794 retval, len);
1795 retval = -EBADMSG;
1796 }
1797 break;
1798 }
1799
1800 /* fail if we can't verify */
1801 for (j = 0; j < len; j++) {
1802 if (buf[j] != (u8)(i + j)) {
1803 ERROR(dev, "ctrl_out, byte %d is %d not %d\n",
1804 j, buf[j], (u8)(i + j));
1805 retval = -EBADMSG;
1806 break;
1807 }
1808 }
1809 if (retval < 0) {
1810 what = "verify";
1811 break;
1812 }
1813
1814 len += vary;
1815
1816 /* [real world] the "zero bytes IN" case isn't really used.
1817 * hardware can easily trip up in this weird case, since its
1818 * status stage is IN, not OUT like other ep0in transfers.
1819 */
1820 if (len > length)
1821 len = realworld ? 1 : 0;
1822 }
1823
1824 if (retval < 0)
1825 ERROR(dev, "ctrl_out %s failed, code %d, count %d\n",
1826 what, retval, i);
1827
1828 kfree(buf - offset);
1829 return retval;
1830}
1831
1832/*-------------------------------------------------------------------------*/
1833
1834/* ISO/BULK tests ... mimics common usage
1835 * - buffer length is split into N packets (mostly maxpacket sized)
1836 * - multi-buffers according to sglen
1837 */
1838
1839struct transfer_context {
1840 unsigned count;
1841 unsigned pending;
1842 spinlock_t lock;
1843 struct completion done;
1844 int submit_error;
1845 unsigned long errors;
1846 unsigned long packet_count;
1847 struct usbtest_dev *dev;
1848 bool is_iso;
1849};
1850
1851static void complicated_callback(struct urb *urb)
1852{
1853 struct transfer_context *ctx = urb->context;
1854
1855 spin_lock(&ctx->lock);
1856 ctx->count--;
1857
1858 ctx->packet_count += urb->number_of_packets;
1859 if (urb->error_count > 0)
1860 ctx->errors += urb->error_count;
1861 else if (urb->status != 0)
1862 ctx->errors += (ctx->is_iso ? urb->number_of_packets : 1);
1863 else if (urb->actual_length != urb->transfer_buffer_length)
1864 ctx->errors++;
1865 else if (check_guard_bytes(ctx->dev, urb) != 0)
1866 ctx->errors++;
1867
1868 if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1869 && !ctx->submit_error) {
1870 int status = usb_submit_urb(urb, GFP_ATOMIC);
1871 switch (status) {
1872 case 0:
1873 goto done;
1874 default:
1875 dev_err(&ctx->dev->intf->dev,
1876 "resubmit err %d\n",
1877 status);
1878 /* FALLTHROUGH */
1879 case -ENODEV: /* disconnected */
1880 case -ESHUTDOWN: /* endpoint disabled */
1881 ctx->submit_error = 1;
1882 break;
1883 }
1884 }
1885
1886 ctx->pending--;
1887 if (ctx->pending == 0) {
1888 if (ctx->errors)
1889 dev_err(&ctx->dev->intf->dev,
1890 "during the test, %lu errors out of %lu\n",
1891 ctx->errors, ctx->packet_count);
1892 complete(&ctx->done);
1893 }
1894done:
1895 spin_unlock(&ctx->lock);
1896}
1897
1898static struct urb *iso_alloc_urb(
1899 struct usb_device *udev,
1900 int pipe,
1901 struct usb_endpoint_descriptor *desc,
1902 long bytes,
1903 unsigned offset
1904)
1905{
1906 struct urb *urb;
1907 unsigned i, maxp, packets;
1908
1909 if (bytes < 0 || !desc)
1910 return NULL;
1911 maxp = 0x7ff & usb_endpoint_maxp(desc);
1912 maxp *= 1 + (0x3 & (usb_endpoint_maxp(desc) >> 11));
1913 packets = DIV_ROUND_UP(bytes, maxp);
1914
1915 urb = usb_alloc_urb(packets, GFP_KERNEL);
1916 if (!urb)
1917 return urb;
1918 urb->dev = udev;
1919 urb->pipe = pipe;
1920
1921 urb->number_of_packets = packets;
1922 urb->transfer_buffer_length = bytes;
1923 urb->transfer_buffer = usb_alloc_coherent(udev, bytes + offset,
1924 GFP_KERNEL,
1925 &urb->transfer_dma);
1926 if (!urb->transfer_buffer) {
1927 usb_free_urb(urb);
1928 return NULL;
1929 }
1930 if (offset) {
1931 memset(urb->transfer_buffer, GUARD_BYTE, offset);
1932 urb->transfer_buffer += offset;
1933 urb->transfer_dma += offset;
1934 }
1935 /* For inbound transfers use guard byte so that test fails if
1936 data not correctly copied */
1937 memset(urb->transfer_buffer,
1938 usb_pipein(urb->pipe) ? GUARD_BYTE : 0,
1939 bytes);
1940
1941 for (i = 0; i < packets; i++) {
1942 /* here, only the last packet will be short */
1943 urb->iso_frame_desc[i].length = min((unsigned) bytes, maxp);
1944 bytes -= urb->iso_frame_desc[i].length;
1945
1946 urb->iso_frame_desc[i].offset = maxp * i;
1947 }
1948
1949 urb->complete = complicated_callback;
1950 /* urb->context = SET BY CALLER */
1951 urb->interval = 1 << (desc->bInterval - 1);
1952 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1953 return urb;
1954}
1955
1956static int
1957test_queue(struct usbtest_dev *dev, struct usbtest_param_32 *param,
1958 int pipe, struct usb_endpoint_descriptor *desc, unsigned offset)
1959{
1960 struct transfer_context context;
1961 struct usb_device *udev;
1962 unsigned i;
1963 unsigned long packets = 0;
1964 int status = 0;
1965 struct urb *urbs[param->sglen];
1966
1967 memset(&context, 0, sizeof(context));
1968 context.count = param->iterations * param->sglen;
1969 context.dev = dev;
1970 context.is_iso = !!desc;
1971 init_completion(&context.done);
1972 spin_lock_init(&context.lock);
1973
1974 udev = testdev_to_usbdev(dev);
1975
1976 for (i = 0; i < param->sglen; i++) {
1977 if (context.is_iso)
1978 urbs[i] = iso_alloc_urb(udev, pipe, desc,
1979 param->length, offset);
1980 else
1981 urbs[i] = complicated_alloc_urb(udev, pipe,
1982 param->length, 0);
1983
1984 if (!urbs[i]) {
1985 status = -ENOMEM;
1986 goto fail;
1987 }
1988 packets += urbs[i]->number_of_packets;
1989 urbs[i]->context = &context;
1990 }
1991 packets *= param->iterations;
1992
1993 if (context.is_iso) {
1994 dev_info(&dev->intf->dev,
1995 "iso period %d %sframes, wMaxPacket %d, transactions: %d\n",
1996 1 << (desc->bInterval - 1),
1997 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1998 usb_endpoint_maxp(desc) & 0x7ff,
1999 1 + (0x3 & (usb_endpoint_maxp(desc) >> 11)));
2000
2001 dev_info(&dev->intf->dev,
2002 "total %lu msec (%lu packets)\n",
2003 (packets * (1 << (desc->bInterval - 1)))
2004 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
2005 packets);
2006 }
2007
2008 spin_lock_irq(&context.lock);
2009 for (i = 0; i < param->sglen; i++) {
2010 ++context.pending;
2011 status = usb_submit_urb(urbs[i], GFP_ATOMIC);
2012 if (status < 0) {
2013 ERROR(dev, "submit iso[%d], error %d\n", i, status);
2014 if (i == 0) {
2015 spin_unlock_irq(&context.lock);
2016 goto fail;
2017 }
2018
2019 simple_free_urb(urbs[i]);
2020 urbs[i] = NULL;
2021 context.pending--;
2022 context.submit_error = 1;
2023 break;
2024 }
2025 }
2026 spin_unlock_irq(&context.lock);
2027
2028 wait_for_completion(&context.done);
2029
2030 for (i = 0; i < param->sglen; i++) {
2031 if (urbs[i])
2032 simple_free_urb(urbs[i]);
2033 }
2034 /*
2035 * Isochronous transfers are expected to fail sometimes. As an
2036 * arbitrary limit, we will report an error if any submissions
2037 * fail or if the transfer failure rate is > 10%.
2038 */
2039 if (status != 0)
2040 ;
2041 else if (context.submit_error)
2042 status = -EACCES;
2043 else if (context.errors >
2044 (context.is_iso ? context.packet_count / 10 : 0))
2045 status = -EIO;
2046 return status;
2047
2048fail:
2049 for (i = 0; i < param->sglen; i++) {
2050 if (urbs[i])
2051 simple_free_urb(urbs[i]);
2052 }
2053 return status;
2054}
2055
2056static int test_unaligned_bulk(
2057 struct usbtest_dev *tdev,
2058 int pipe,
2059 unsigned length,
2060 int iterations,
2061 unsigned transfer_flags,
2062 const char *label)
2063{
2064 int retval;
2065 struct urb *urb = usbtest_alloc_urb(testdev_to_usbdev(tdev),
2066 pipe, length, transfer_flags, 1, 0, simple_callback);
2067
2068 if (!urb)
2069 return -ENOMEM;
2070
2071 retval = simple_io(tdev, urb, iterations, 0, 0, label);
2072 simple_free_urb(urb);
2073 return retval;
2074}
2075
2076/* Run tests. */
2077static int
2078usbtest_do_ioctl(struct usb_interface *intf, struct usbtest_param_32 *param)
2079{
2080 struct usbtest_dev *dev = usb_get_intfdata(intf);
2081 struct usb_device *udev = testdev_to_usbdev(dev);
2082 struct urb *urb;
2083 struct scatterlist *sg;
2084 struct usb_sg_request req;
2085 unsigned i;
2086 int retval = -EOPNOTSUPP;
2087
2088 if (param->iterations <= 0)
2089 return -EINVAL;
2090 /*
2091 * Just a bunch of test cases that every HCD is expected to handle.
2092 *
2093 * Some may need specific firmware, though it'd be good to have
2094 * one firmware image to handle all the test cases.
2095 *
2096 * FIXME add more tests! cancel requests, verify the data, control
2097 * queueing, concurrent read+write threads, and so on.
2098 */
2099 switch (param->test_num) {
2100
2101 case 0:
2102 dev_info(&intf->dev, "TEST 0: NOP\n");
2103 retval = 0;
2104 break;
2105
2106 /* Simple non-queued bulk I/O tests */
2107 case 1:
2108 if (dev->out_pipe == 0)
2109 break;
2110 dev_info(&intf->dev,
2111 "TEST 1: write %d bytes %u times\n",
2112 param->length, param->iterations);
2113 urb = simple_alloc_urb(udev, dev->out_pipe, param->length, 0);
2114 if (!urb) {
2115 retval = -ENOMEM;
2116 break;
2117 }
2118 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2119 retval = simple_io(dev, urb, param->iterations, 0, 0, "test1");
2120 simple_free_urb(urb);
2121 break;
2122 case 2:
2123 if (dev->in_pipe == 0)
2124 break;
2125 dev_info(&intf->dev,
2126 "TEST 2: read %d bytes %u times\n",
2127 param->length, param->iterations);
2128 urb = simple_alloc_urb(udev, dev->in_pipe, param->length, 0);
2129 if (!urb) {
2130 retval = -ENOMEM;
2131 break;
2132 }
2133 /* FIRMWARE: bulk source (maybe generates short writes) */
2134 retval = simple_io(dev, urb, param->iterations, 0, 0, "test2");
2135 simple_free_urb(urb);
2136 break;
2137 case 3:
2138 if (dev->out_pipe == 0 || param->vary == 0)
2139 break;
2140 dev_info(&intf->dev,
2141 "TEST 3: write/%d 0..%d bytes %u times\n",
2142 param->vary, param->length, param->iterations);
2143 urb = simple_alloc_urb(udev, dev->out_pipe, param->length, 0);
2144 if (!urb) {
2145 retval = -ENOMEM;
2146 break;
2147 }
2148 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2149 retval = simple_io(dev, urb, param->iterations, param->vary,
2150 0, "test3");
2151 simple_free_urb(urb);
2152 break;
2153 case 4:
2154 if (dev->in_pipe == 0 || param->vary == 0)
2155 break;
2156 dev_info(&intf->dev,
2157 "TEST 4: read/%d 0..%d bytes %u times\n",
2158 param->vary, param->length, param->iterations);
2159 urb = simple_alloc_urb(udev, dev->in_pipe, param->length, 0);
2160 if (!urb) {
2161 retval = -ENOMEM;
2162 break;
2163 }
2164 /* FIRMWARE: bulk source (maybe generates short writes) */
2165 retval = simple_io(dev, urb, param->iterations, param->vary,
2166 0, "test4");
2167 simple_free_urb(urb);
2168 break;
2169
2170 /* Queued bulk I/O tests */
2171 case 5:
2172 if (dev->out_pipe == 0 || param->sglen == 0)
2173 break;
2174 dev_info(&intf->dev,
2175 "TEST 5: write %d sglists %d entries of %d bytes\n",
2176 param->iterations,
2177 param->sglen, param->length);
2178 sg = alloc_sglist(param->sglen, param->length,
2179 0, dev, dev->out_pipe);
2180 if (!sg) {
2181 retval = -ENOMEM;
2182 break;
2183 }
2184 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2185 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
2186 &req, sg, param->sglen);
2187 free_sglist(sg, param->sglen);
2188 break;
2189
2190 case 6:
2191 if (dev->in_pipe == 0 || param->sglen == 0)
2192 break;
2193 dev_info(&intf->dev,
2194 "TEST 6: read %d sglists %d entries of %d bytes\n",
2195 param->iterations,
2196 param->sglen, param->length);
2197 sg = alloc_sglist(param->sglen, param->length,
2198 0, dev, dev->in_pipe);
2199 if (!sg) {
2200 retval = -ENOMEM;
2201 break;
2202 }
2203 /* FIRMWARE: bulk source (maybe generates short writes) */
2204 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
2205 &req, sg, param->sglen);
2206 free_sglist(sg, param->sglen);
2207 break;
2208 case 7:
2209 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
2210 break;
2211 dev_info(&intf->dev,
2212 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
2213 param->vary, param->iterations,
2214 param->sglen, param->length);
2215 sg = alloc_sglist(param->sglen, param->length,
2216 param->vary, dev, dev->out_pipe);
2217 if (!sg) {
2218 retval = -ENOMEM;
2219 break;
2220 }
2221 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2222 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
2223 &req, sg, param->sglen);
2224 free_sglist(sg, param->sglen);
2225 break;
2226 case 8:
2227 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
2228 break;
2229 dev_info(&intf->dev,
2230 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
2231 param->vary, param->iterations,
2232 param->sglen, param->length);
2233 sg = alloc_sglist(param->sglen, param->length,
2234 param->vary, dev, dev->in_pipe);
2235 if (!sg) {
2236 retval = -ENOMEM;
2237 break;
2238 }
2239 /* FIRMWARE: bulk source (maybe generates short writes) */
2240 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
2241 &req, sg, param->sglen);
2242 free_sglist(sg, param->sglen);
2243 break;
2244
2245 /* non-queued sanity tests for control (chapter 9 subset) */
2246 case 9:
2247 retval = 0;
2248 dev_info(&intf->dev,
2249 "TEST 9: ch9 (subset) control tests, %d times\n",
2250 param->iterations);
2251 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2252 retval = ch9_postconfig(dev);
2253 if (retval)
2254 dev_err(&intf->dev, "ch9 subset failed, "
2255 "iterations left %d\n", i);
2256 break;
2257
2258 /* queued control messaging */
2259 case 10:
2260 retval = 0;
2261 dev_info(&intf->dev,
2262 "TEST 10: queue %d control calls, %d times\n",
2263 param->sglen,
2264 param->iterations);
2265 retval = test_ctrl_queue(dev, param);
2266 break;
2267
2268 /* simple non-queued unlinks (ring with one urb) */
2269 case 11:
2270 if (dev->in_pipe == 0 || !param->length)
2271 break;
2272 retval = 0;
2273 dev_info(&intf->dev, "TEST 11: unlink %d reads of %d\n",
2274 param->iterations, param->length);
2275 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2276 retval = unlink_simple(dev, dev->in_pipe,
2277 param->length);
2278 if (retval)
2279 dev_err(&intf->dev, "unlink reads failed %d, "
2280 "iterations left %d\n", retval, i);
2281 break;
2282 case 12:
2283 if (dev->out_pipe == 0 || !param->length)
2284 break;
2285 retval = 0;
2286 dev_info(&intf->dev, "TEST 12: unlink %d writes of %d\n",
2287 param->iterations, param->length);
2288 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2289 retval = unlink_simple(dev, dev->out_pipe,
2290 param->length);
2291 if (retval)
2292 dev_err(&intf->dev, "unlink writes failed %d, "
2293 "iterations left %d\n", retval, i);
2294 break;
2295
2296 /* ep halt tests */
2297 case 13:
2298 if (dev->out_pipe == 0 && dev->in_pipe == 0)
2299 break;
2300 retval = 0;
2301 dev_info(&intf->dev, "TEST 13: set/clear %d halts\n",
2302 param->iterations);
2303 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2304 retval = halt_simple(dev);
2305
2306 if (retval)
2307 ERROR(dev, "halts failed, iterations left %d\n", i);
2308 break;
2309
2310 /* control write tests */
2311 case 14:
2312 if (!dev->info->ctrl_out)
2313 break;
2314 dev_info(&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
2315 param->iterations,
2316 realworld ? 1 : 0, param->length,
2317 param->vary);
2318 retval = ctrl_out(dev, param->iterations,
2319 param->length, param->vary, 0);
2320 break;
2321
2322 /* iso write tests */
2323 case 15:
2324 if (dev->out_iso_pipe == 0 || param->sglen == 0)
2325 break;
2326 dev_info(&intf->dev,
2327 "TEST 15: write %d iso, %d entries of %d bytes\n",
2328 param->iterations,
2329 param->sglen, param->length);
2330 /* FIRMWARE: iso sink */
2331 retval = test_queue(dev, param,
2332 dev->out_iso_pipe, dev->iso_out, 0);
2333 break;
2334
2335 /* iso read tests */
2336 case 16:
2337 if (dev->in_iso_pipe == 0 || param->sglen == 0)
2338 break;
2339 dev_info(&intf->dev,
2340 "TEST 16: read %d iso, %d entries of %d bytes\n",
2341 param->iterations,
2342 param->sglen, param->length);
2343 /* FIRMWARE: iso source */
2344 retval = test_queue(dev, param,
2345 dev->in_iso_pipe, dev->iso_in, 0);
2346 break;
2347
2348 /* FIXME scatterlist cancel (needs helper thread) */
2349
2350 /* Tests for bulk I/O using DMA mapping by core and odd address */
2351 case 17:
2352 if (dev->out_pipe == 0)
2353 break;
2354 dev_info(&intf->dev,
2355 "TEST 17: write odd addr %d bytes %u times core map\n",
2356 param->length, param->iterations);
2357
2358 retval = test_unaligned_bulk(
2359 dev, dev->out_pipe,
2360 param->length, param->iterations,
2361 0, "test17");
2362 break;
2363
2364 case 18:
2365 if (dev->in_pipe == 0)
2366 break;
2367 dev_info(&intf->dev,
2368 "TEST 18: read odd addr %d bytes %u times core map\n",
2369 param->length, param->iterations);
2370
2371 retval = test_unaligned_bulk(
2372 dev, dev->in_pipe,
2373 param->length, param->iterations,
2374 0, "test18");
2375 break;
2376
2377 /* Tests for bulk I/O using premapped coherent buffer and odd address */
2378 case 19:
2379 if (dev->out_pipe == 0)
2380 break;
2381 dev_info(&intf->dev,
2382 "TEST 19: write odd addr %d bytes %u times premapped\n",
2383 param->length, param->iterations);
2384
2385 retval = test_unaligned_bulk(
2386 dev, dev->out_pipe,
2387 param->length, param->iterations,
2388 URB_NO_TRANSFER_DMA_MAP, "test19");
2389 break;
2390
2391 case 20:
2392 if (dev->in_pipe == 0)
2393 break;
2394 dev_info(&intf->dev,
2395 "TEST 20: read odd addr %d bytes %u times premapped\n",
2396 param->length, param->iterations);
2397
2398 retval = test_unaligned_bulk(
2399 dev, dev->in_pipe,
2400 param->length, param->iterations,
2401 URB_NO_TRANSFER_DMA_MAP, "test20");
2402 break;
2403
2404 /* control write tests with unaligned buffer */
2405 case 21:
2406 if (!dev->info->ctrl_out)
2407 break;
2408 dev_info(&intf->dev,
2409 "TEST 21: %d ep0out odd addr, %d..%d vary %d\n",
2410 param->iterations,
2411 realworld ? 1 : 0, param->length,
2412 param->vary);
2413 retval = ctrl_out(dev, param->iterations,
2414 param->length, param->vary, 1);
2415 break;
2416
2417 /* unaligned iso tests */
2418 case 22:
2419 if (dev->out_iso_pipe == 0 || param->sglen == 0)
2420 break;
2421 dev_info(&intf->dev,
2422 "TEST 22: write %d iso odd, %d entries of %d bytes\n",
2423 param->iterations,
2424 param->sglen, param->length);
2425 retval = test_queue(dev, param,
2426 dev->out_iso_pipe, dev->iso_out, 1);
2427 break;
2428
2429 case 23:
2430 if (dev->in_iso_pipe == 0 || param->sglen == 0)
2431 break;
2432 dev_info(&intf->dev,
2433 "TEST 23: read %d iso odd, %d entries of %d bytes\n",
2434 param->iterations,
2435 param->sglen, param->length);
2436 retval = test_queue(dev, param,
2437 dev->in_iso_pipe, dev->iso_in, 1);
2438 break;
2439
2440 /* unlink URBs from a bulk-OUT queue */
2441 case 24:
2442 if (dev->out_pipe == 0 || !param->length || param->sglen < 4)
2443 break;
2444 retval = 0;
2445 dev_info(&intf->dev, "TEST 24: unlink from %d queues of "
2446 "%d %d-byte writes\n",
2447 param->iterations, param->sglen, param->length);
2448 for (i = param->iterations; retval == 0 && i > 0; --i) {
2449 retval = unlink_queued(dev, dev->out_pipe,
2450 param->sglen, param->length);
2451 if (retval) {
2452 dev_err(&intf->dev,
2453 "unlink queued writes failed %d, "
2454 "iterations left %d\n", retval, i);
2455 break;
2456 }
2457 }
2458 break;
2459
2460 /* Simple non-queued interrupt I/O tests */
2461 case 25:
2462 if (dev->out_int_pipe == 0)
2463 break;
2464 dev_info(&intf->dev,
2465 "TEST 25: write %d bytes %u times\n",
2466 param->length, param->iterations);
2467 urb = simple_alloc_urb(udev, dev->out_int_pipe, param->length,
2468 dev->int_out->bInterval);
2469 if (!urb) {
2470 retval = -ENOMEM;
2471 break;
2472 }
2473 /* FIRMWARE: interrupt sink (maybe accepts short writes) */
2474 retval = simple_io(dev, urb, param->iterations, 0, 0, "test25");
2475 simple_free_urb(urb);
2476 break;
2477 case 26:
2478 if (dev->in_int_pipe == 0)
2479 break;
2480 dev_info(&intf->dev,
2481 "TEST 26: read %d bytes %u times\n",
2482 param->length, param->iterations);
2483 urb = simple_alloc_urb(udev, dev->in_int_pipe, param->length,
2484 dev->int_in->bInterval);
2485 if (!urb) {
2486 retval = -ENOMEM;
2487 break;
2488 }
2489 /* FIRMWARE: interrupt source (maybe generates short writes) */
2490 retval = simple_io(dev, urb, param->iterations, 0, 0, "test26");
2491 simple_free_urb(urb);
2492 break;
2493 case 27:
2494 /* We do performance test, so ignore data compare */
2495 if (dev->out_pipe == 0 || param->sglen == 0 || pattern != 0)
2496 break;
2497 dev_info(&intf->dev,
2498 "TEST 27: bulk write %dMbytes\n", (param->iterations *
2499 param->sglen * param->length) / (1024 * 1024));
2500 retval = test_queue(dev, param,
2501 dev->out_pipe, NULL, 0);
2502 break;
2503 case 28:
2504 if (dev->in_pipe == 0 || param->sglen == 0 || pattern != 0)
2505 break;
2506 dev_info(&intf->dev,
2507 "TEST 28: bulk read %dMbytes\n", (param->iterations *
2508 param->sglen * param->length) / (1024 * 1024));
2509 retval = test_queue(dev, param,
2510 dev->in_pipe, NULL, 0);
2511 break;
2512 }
2513 return retval;
2514}
2515
2516/*-------------------------------------------------------------------------*/
2517
2518/* We only have this one interface to user space, through usbfs.
2519 * User mode code can scan usbfs to find N different devices (maybe on
2520 * different busses) to use when testing, and allocate one thread per
2521 * test. So discovery is simplified, and we have no device naming issues.
2522 *
2523 * Don't use these only as stress/load tests. Use them along with with
2524 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
2525 * video capture, and so on. Run different tests at different times, in
2526 * different sequences. Nothing here should interact with other devices,
2527 * except indirectly by consuming USB bandwidth and CPU resources for test
2528 * threads and request completion. But the only way to know that for sure
2529 * is to test when HC queues are in use by many devices.
2530 *
2531 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
2532 * it locks out usbcore in certain code paths. Notably, if you disconnect
2533 * the device-under-test, hub_wq will wait block forever waiting for the
2534 * ioctl to complete ... so that usb_disconnect() can abort the pending
2535 * urbs and then call usbtest_disconnect(). To abort a test, you're best
2536 * off just killing the userspace task and waiting for it to exit.
2537 */
2538
2539static int
2540usbtest_ioctl(struct usb_interface *intf, unsigned int code, void *buf)
2541{
2542
2543 struct usbtest_dev *dev = usb_get_intfdata(intf);
2544 struct usbtest_param_64 *param_64 = buf;
2545 struct usbtest_param_32 temp;
2546 struct usbtest_param_32 *param_32 = buf;
2547 struct timespec64 start;
2548 struct timespec64 end;
2549 struct timespec64 duration;
2550 int retval = -EOPNOTSUPP;
2551
2552 /* FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is. */
2553
2554 pattern = mod_pattern;
2555
2556 if (mutex_lock_interruptible(&dev->lock))
2557 return -ERESTARTSYS;
2558
2559 /* FIXME: What if a system sleep starts while a test is running? */
2560
2561 /* some devices, like ez-usb default devices, need a non-default
2562 * altsetting to have any active endpoints. some tests change
2563 * altsettings; force a default so most tests don't need to check.
2564 */
2565 if (dev->info->alt >= 0) {
2566 if (intf->altsetting->desc.bInterfaceNumber) {
2567 retval = -ENODEV;
2568 goto free_mutex;
2569 }
2570 retval = set_altsetting(dev, dev->info->alt);
2571 if (retval) {
2572 dev_err(&intf->dev,
2573 "set altsetting to %d failed, %d\n",
2574 dev->info->alt, retval);
2575 goto free_mutex;
2576 }
2577 }
2578
2579 switch (code) {
2580 case USBTEST_REQUEST_64:
2581 temp.test_num = param_64->test_num;
2582 temp.iterations = param_64->iterations;
2583 temp.length = param_64->length;
2584 temp.sglen = param_64->sglen;
2585 temp.vary = param_64->vary;
2586 param_32 = &temp;
2587 break;
2588
2589 case USBTEST_REQUEST_32:
2590 break;
2591
2592 default:
2593 retval = -EOPNOTSUPP;
2594 goto free_mutex;
2595 }
2596
2597 ktime_get_ts64(&start);
2598
2599 retval = usbtest_do_ioctl(intf, param_32);
2600 if (retval)
2601 goto free_mutex;
2602
2603 ktime_get_ts64(&end);
2604
2605 duration = timespec64_sub(end, start);
2606
2607 temp.duration_sec = duration.tv_sec;
2608 temp.duration_usec = duration.tv_nsec/NSEC_PER_USEC;
2609
2610 switch (code) {
2611 case USBTEST_REQUEST_32:
2612 param_32->duration_sec = temp.duration_sec;
2613 param_32->duration_usec = temp.duration_usec;
2614 break;
2615
2616 case USBTEST_REQUEST_64:
2617 param_64->duration_sec = temp.duration_sec;
2618 param_64->duration_usec = temp.duration_usec;
2619 break;
2620 }
2621
2622free_mutex:
2623 mutex_unlock(&dev->lock);
2624 return retval;
2625}
2626
2627/*-------------------------------------------------------------------------*/
2628
2629static unsigned force_interrupt;
2630module_param(force_interrupt, uint, 0);
2631MODULE_PARM_DESC(force_interrupt, "0 = test default; else interrupt");
2632
2633#ifdef GENERIC
2634static unsigned short vendor;
2635module_param(vendor, ushort, 0);
2636MODULE_PARM_DESC(vendor, "vendor code (from usb-if)");
2637
2638static unsigned short product;
2639module_param(product, ushort, 0);
2640MODULE_PARM_DESC(product, "product code (from vendor)");
2641#endif
2642
2643static int
2644usbtest_probe(struct usb_interface *intf, const struct usb_device_id *id)
2645{
2646 struct usb_device *udev;
2647 struct usbtest_dev *dev;
2648 struct usbtest_info *info;
2649 char *rtest, *wtest;
2650 char *irtest, *iwtest;
2651 char *intrtest, *intwtest;
2652
2653 udev = interface_to_usbdev(intf);
2654
2655#ifdef GENERIC
2656 /* specify devices by module parameters? */
2657 if (id->match_flags == 0) {
2658 /* vendor match required, product match optional */
2659 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
2660 return -ENODEV;
2661 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
2662 return -ENODEV;
2663 dev_info(&intf->dev, "matched module params, "
2664 "vend=0x%04x prod=0x%04x\n",
2665 le16_to_cpu(udev->descriptor.idVendor),
2666 le16_to_cpu(udev->descriptor.idProduct));
2667 }
2668#endif
2669
2670 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2671 if (!dev)
2672 return -ENOMEM;
2673 info = (struct usbtest_info *) id->driver_info;
2674 dev->info = info;
2675 mutex_init(&dev->lock);
2676
2677 dev->intf = intf;
2678
2679 /* cacheline-aligned scratch for i/o */
2680 dev->buf = kmalloc(TBUF_SIZE, GFP_KERNEL);
2681 if (dev->buf == NULL) {
2682 kfree(dev);
2683 return -ENOMEM;
2684 }
2685
2686 /* NOTE this doesn't yet test the handful of difference that are
2687 * visible with high speed interrupts: bigger maxpacket (1K) and
2688 * "high bandwidth" modes (up to 3 packets/uframe).
2689 */
2690 rtest = wtest = "";
2691 irtest = iwtest = "";
2692 intrtest = intwtest = "";
2693 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
2694 if (info->ep_in) {
2695 dev->in_pipe = usb_rcvintpipe(udev, info->ep_in);
2696 rtest = " intr-in";
2697 }
2698 if (info->ep_out) {
2699 dev->out_pipe = usb_sndintpipe(udev, info->ep_out);
2700 wtest = " intr-out";
2701 }
2702 } else {
2703 if (override_alt >= 0 || info->autoconf) {
2704 int status;
2705
2706 status = get_endpoints(dev, intf);
2707 if (status < 0) {
2708 WARNING(dev, "couldn't get endpoints, %d\n",
2709 status);
2710 kfree(dev->buf);
2711 kfree(dev);
2712 return status;
2713 }
2714 /* may find bulk or ISO pipes */
2715 } else {
2716 if (info->ep_in)
2717 dev->in_pipe = usb_rcvbulkpipe(udev,
2718 info->ep_in);
2719 if (info->ep_out)
2720 dev->out_pipe = usb_sndbulkpipe(udev,
2721 info->ep_out);
2722 }
2723 if (dev->in_pipe)
2724 rtest = " bulk-in";
2725 if (dev->out_pipe)
2726 wtest = " bulk-out";
2727 if (dev->in_iso_pipe)
2728 irtest = " iso-in";
2729 if (dev->out_iso_pipe)
2730 iwtest = " iso-out";
2731 if (dev->in_int_pipe)
2732 intrtest = " int-in";
2733 if (dev->out_int_pipe)
2734 intwtest = " int-out";
2735 }
2736
2737 usb_set_intfdata(intf, dev);
2738 dev_info(&intf->dev, "%s\n", info->name);
2739 dev_info(&intf->dev, "%s {control%s%s%s%s%s%s%s} tests%s\n",
2740 usb_speed_string(udev->speed),
2741 info->ctrl_out ? " in/out" : "",
2742 rtest, wtest,
2743 irtest, iwtest,
2744 intrtest, intwtest,
2745 info->alt >= 0 ? " (+alt)" : "");
2746 return 0;
2747}
2748
2749static int usbtest_suspend(struct usb_interface *intf, pm_message_t message)
2750{
2751 return 0;
2752}
2753
2754static int usbtest_resume(struct usb_interface *intf)
2755{
2756 return 0;
2757}
2758
2759
2760static void usbtest_disconnect(struct usb_interface *intf)
2761{
2762 struct usbtest_dev *dev = usb_get_intfdata(intf);
2763
2764 usb_set_intfdata(intf, NULL);
2765 dev_dbg(&intf->dev, "disconnect\n");
2766 kfree(dev);
2767}
2768
2769/* Basic testing only needs a device that can source or sink bulk traffic.
2770 * Any device can test control transfers (default with GENERIC binding).
2771 *
2772 * Several entries work with the default EP0 implementation that's built
2773 * into EZ-USB chips. There's a default vendor ID which can be overridden
2774 * by (very) small config EEPROMS, but otherwise all these devices act
2775 * identically until firmware is loaded: only EP0 works. It turns out
2776 * to be easy to make other endpoints work, without modifying that EP0
2777 * behavior. For now, we expect that kind of firmware.
2778 */
2779
2780/* an21xx or fx versions of ez-usb */
2781static struct usbtest_info ez1_info = {
2782 .name = "EZ-USB device",
2783 .ep_in = 2,
2784 .ep_out = 2,
2785 .alt = 1,
2786};
2787
2788/* fx2 version of ez-usb */
2789static struct usbtest_info ez2_info = {
2790 .name = "FX2 device",
2791 .ep_in = 6,
2792 .ep_out = 2,
2793 .alt = 1,
2794};
2795
2796/* ezusb family device with dedicated usb test firmware,
2797 */
2798static struct usbtest_info fw_info = {
2799 .name = "usb test device",
2800 .ep_in = 2,
2801 .ep_out = 2,
2802 .alt = 1,
2803 .autoconf = 1, /* iso and ctrl_out need autoconf */
2804 .ctrl_out = 1,
2805 .iso = 1, /* iso_ep's are #8 in/out */
2806};
2807
2808/* peripheral running Linux and 'zero.c' test firmware, or
2809 * its user-mode cousin. different versions of this use
2810 * different hardware with the same vendor/product codes.
2811 * host side MUST rely on the endpoint descriptors.
2812 */
2813static struct usbtest_info gz_info = {
2814 .name = "Linux gadget zero",
2815 .autoconf = 1,
2816 .ctrl_out = 1,
2817 .iso = 1,
2818 .intr = 1,
2819 .alt = 0,
2820};
2821
2822static struct usbtest_info um_info = {
2823 .name = "Linux user mode test driver",
2824 .autoconf = 1,
2825 .alt = -1,
2826};
2827
2828static struct usbtest_info um2_info = {
2829 .name = "Linux user mode ISO test driver",
2830 .autoconf = 1,
2831 .iso = 1,
2832 .alt = -1,
2833};
2834
2835#ifdef IBOT2
2836/* this is a nice source of high speed bulk data;
2837 * uses an FX2, with firmware provided in the device
2838 */
2839static struct usbtest_info ibot2_info = {
2840 .name = "iBOT2 webcam",
2841 .ep_in = 2,
2842 .alt = -1,
2843};
2844#endif
2845
2846#ifdef GENERIC
2847/* we can use any device to test control traffic */
2848static struct usbtest_info generic_info = {
2849 .name = "Generic USB device",
2850 .alt = -1,
2851};
2852#endif
2853
2854
2855static const struct usb_device_id id_table[] = {
2856
2857 /*-------------------------------------------------------------*/
2858
2859 /* EZ-USB devices which download firmware to replace (or in our
2860 * case augment) the default device implementation.
2861 */
2862
2863 /* generic EZ-USB FX controller */
2864 { USB_DEVICE(0x0547, 0x2235),
2865 .driver_info = (unsigned long) &ez1_info,
2866 },
2867
2868 /* CY3671 development board with EZ-USB FX */
2869 { USB_DEVICE(0x0547, 0x0080),
2870 .driver_info = (unsigned long) &ez1_info,
2871 },
2872
2873 /* generic EZ-USB FX2 controller (or development board) */
2874 { USB_DEVICE(0x04b4, 0x8613),
2875 .driver_info = (unsigned long) &ez2_info,
2876 },
2877
2878 /* re-enumerated usb test device firmware */
2879 { USB_DEVICE(0xfff0, 0xfff0),
2880 .driver_info = (unsigned long) &fw_info,
2881 },
2882
2883 /* "Gadget Zero" firmware runs under Linux */
2884 { USB_DEVICE(0x0525, 0xa4a0),
2885 .driver_info = (unsigned long) &gz_info,
2886 },
2887
2888 /* so does a user-mode variant */
2889 { USB_DEVICE(0x0525, 0xa4a4),
2890 .driver_info = (unsigned long) &um_info,
2891 },
2892
2893 /* ... and a user-mode variant that talks iso */
2894 { USB_DEVICE(0x0525, 0xa4a3),
2895 .driver_info = (unsigned long) &um2_info,
2896 },
2897
2898#ifdef KEYSPAN_19Qi
2899 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2900 /* this does not coexist with the real Keyspan 19qi driver! */
2901 { USB_DEVICE(0x06cd, 0x010b),
2902 .driver_info = (unsigned long) &ez1_info,
2903 },
2904#endif
2905
2906 /*-------------------------------------------------------------*/
2907
2908#ifdef IBOT2
2909 /* iBOT2 makes a nice source of high speed bulk-in data */
2910 /* this does not coexist with a real iBOT2 driver! */
2911 { USB_DEVICE(0x0b62, 0x0059),
2912 .driver_info = (unsigned long) &ibot2_info,
2913 },
2914#endif
2915
2916 /*-------------------------------------------------------------*/
2917
2918#ifdef GENERIC
2919 /* module params can specify devices to use for control tests */
2920 { .driver_info = (unsigned long) &generic_info, },
2921#endif
2922
2923 /*-------------------------------------------------------------*/
2924
2925 { }
2926};
2927MODULE_DEVICE_TABLE(usb, id_table);
2928
2929static struct usb_driver usbtest_driver = {
2930 .name = "usbtest",
2931 .id_table = id_table,
2932 .probe = usbtest_probe,
2933 .unlocked_ioctl = usbtest_ioctl,
2934 .disconnect = usbtest_disconnect,
2935 .suspend = usbtest_suspend,
2936 .resume = usbtest_resume,
2937};
2938
2939/*-------------------------------------------------------------------------*/
2940
2941static int __init usbtest_init(void)
2942{
2943#ifdef GENERIC
2944 if (vendor)
2945 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor, product);
2946#endif
2947 return usb_register(&usbtest_driver);
2948}
2949module_init(usbtest_init);
2950
2951static void __exit usbtest_exit(void)
2952{
2953 usb_deregister(&usbtest_driver);
2954}
2955module_exit(usbtest_exit);
2956
2957MODULE_DESCRIPTION("USB Core/HCD Testing Driver");
2958MODULE_LICENSE("GPL");
2959