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