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