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