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