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