blob: 194065dbb51f0866831b0976b3da05c167178c06 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
David Hardeman378f0582005-09-17 17:55:31 +10008#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10#include <linux/usb.h>
11
12
13/*-------------------------------------------------------------------------*/
14
15// FIXME make these public somewhere; usbdevfs.h?
16//
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 semaphore sem;
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 xprintk(tdev,level,fmt,args...) \
82 dev_printk(level , &(tdev)->intf->dev , fmt , ## args)
83
84#ifdef DEBUG
85#define DBG(dev,fmt,args...) \
86 xprintk(dev , KERN_DEBUG , fmt , ## args)
87#else
88#define DBG(dev,fmt,args...) \
89 do { } while (0)
90#endif /* DEBUG */
91
92#ifdef VERBOSE
93#define VDBG DBG
94#else
95#define VDBG(dev,fmt,args...) \
96 do { } while (0)
97#endif /* VERBOSE */
98
99#define ERROR(dev,fmt,args...) \
100 xprintk(dev , KERN_ERR , fmt , ## args)
101#define WARN(dev,fmt,args...) \
102 xprintk(dev , KERN_WARNING , fmt , ## args)
103#define INFO(dev,fmt,args...) \
104 xprintk(dev , KERN_INFO , fmt , ## args)
105
106/*-------------------------------------------------------------------------*/
107
108static int
109get_endpoints (struct usbtest_dev *dev, struct usb_interface *intf)
110{
111 int tmp;
112 struct usb_host_interface *alt;
113 struct usb_host_endpoint *in, *out;
114 struct usb_host_endpoint *iso_in, *iso_out;
115 struct usb_device *udev;
116
117 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
118 unsigned ep;
119
120 in = out = NULL;
121 iso_in = iso_out = NULL;
122 alt = intf->altsetting + tmp;
123
124 /* take the first altsetting with in-bulk + out-bulk;
125 * ignore other endpoints and altsetttings.
126 */
127 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
128 struct usb_host_endpoint *e;
129
130 e = alt->endpoint + ep;
131 switch (e->desc.bmAttributes) {
132 case USB_ENDPOINT_XFER_BULK:
133 break;
134 case USB_ENDPOINT_XFER_ISOC:
135 if (dev->info->iso)
136 goto try_iso;
137 // FALLTHROUGH
138 default:
139 continue;
140 }
Luiz Fernando N. Capitulino4d823dd2006-10-26 13:03:02 -0300141 if (usb_endpoint_dir_in(&e->desc)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 if (!in)
143 in = e;
144 } else {
145 if (!out)
146 out = e;
147 }
148 continue;
149try_iso:
Luiz Fernando N. Capitulino4d823dd2006-10-26 13:03:02 -0300150 if (usb_endpoint_dir_in(&e->desc)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 if (!iso_in)
152 iso_in = e;
153 } else {
154 if (!iso_out)
155 iso_out = e;
156 }
157 }
158 if ((in && out) || (iso_in && iso_out))
159 goto found;
160 }
161 return -EINVAL;
162
163found:
164 udev = testdev_to_usbdev (dev);
165 if (alt->desc.bAlternateSetting != 0) {
166 tmp = usb_set_interface (udev,
167 alt->desc.bInterfaceNumber,
168 alt->desc.bAlternateSetting);
169 if (tmp < 0)
170 return tmp;
171 }
172
173 if (in) {
174 dev->in_pipe = usb_rcvbulkpipe (udev,
175 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
176 dev->out_pipe = usb_sndbulkpipe (udev,
177 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
178 }
179 if (iso_in) {
180 dev->iso_in = &iso_in->desc;
181 dev->in_iso_pipe = usb_rcvisocpipe (udev,
182 iso_in->desc.bEndpointAddress
183 & USB_ENDPOINT_NUMBER_MASK);
184 dev->iso_out = &iso_out->desc;
185 dev->out_iso_pipe = usb_sndisocpipe (udev,
186 iso_out->desc.bEndpointAddress
187 & USB_ENDPOINT_NUMBER_MASK);
188 }
189 return 0;
190}
191
192/*-------------------------------------------------------------------------*/
193
194/* Support for testing basic non-queued I/O streams.
195 *
196 * These just package urbs as requests that can be easily canceled.
197 * Each urb's data buffer is dynamically allocated; callers can fill
198 * them with non-zero test data (or test for it) when appropriate.
199 */
200
David Howells7d12e782006-10-05 14:55:46 +0100201static void simple_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202{
203 complete ((struct completion *) urb->context);
204}
205
206static struct urb *simple_alloc_urb (
207 struct usb_device *udev,
208 int pipe,
209 unsigned long bytes
210)
211{
212 struct urb *urb;
213
214 if (bytes < 0)
215 return NULL;
216 urb = usb_alloc_urb (0, SLAB_KERNEL);
217 if (!urb)
218 return urb;
219 usb_fill_bulk_urb (urb, udev, pipe, NULL, bytes, simple_callback, NULL);
220 urb->interval = (udev->speed == USB_SPEED_HIGH)
221 ? (INTERRUPT_RATE << 3)
222 : INTERRUPT_RATE;
223 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
224 if (usb_pipein (pipe))
225 urb->transfer_flags |= URB_SHORT_NOT_OK;
226 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, SLAB_KERNEL,
227 &urb->transfer_dma);
228 if (!urb->transfer_buffer) {
229 usb_free_urb (urb);
230 urb = NULL;
231 } else
232 memset (urb->transfer_buffer, 0, bytes);
233 return urb;
234}
235
236static unsigned pattern = 0;
237module_param (pattern, uint, S_IRUGO);
238// MODULE_PARM_DESC (pattern, "i/o pattern (0 == zeroes)");
239
240static inline void simple_fill_buf (struct urb *urb)
241{
242 unsigned i;
243 u8 *buf = urb->transfer_buffer;
244 unsigned len = urb->transfer_buffer_length;
245
246 switch (pattern) {
247 default:
248 // FALLTHROUGH
249 case 0:
250 memset (buf, 0, len);
251 break;
252 case 1: /* mod63 */
253 for (i = 0; i < len; i++)
254 *buf++ = (u8) (i % 63);
255 break;
256 }
257}
258
259static inline int simple_check_buf (struct urb *urb)
260{
261 unsigned i;
262 u8 expected;
263 u8 *buf = urb->transfer_buffer;
264 unsigned len = urb->actual_length;
265
266 for (i = 0; i < len; i++, buf++) {
267 switch (pattern) {
268 /* all-zeroes has no synchronization issues */
269 case 0:
270 expected = 0;
271 break;
272 /* mod63 stays in sync with short-terminated transfers,
273 * or otherwise when host and gadget agree on how large
274 * each usb transfer request should be. resync is done
275 * with set_interface or set_config.
276 */
277 case 1: /* mod63 */
278 expected = i % 63;
279 break;
280 /* always fail unsupported patterns */
281 default:
282 expected = !*buf;
283 break;
284 }
285 if (*buf == expected)
286 continue;
287 dbg ("buf[%d] = %d (not %d)", i, *buf, expected);
288 return -EINVAL;
289 }
290 return 0;
291}
292
293static void simple_free_urb (struct urb *urb)
294{
295 usb_buffer_free (urb->dev, urb->transfer_buffer_length,
296 urb->transfer_buffer, urb->transfer_dma);
297 usb_free_urb (urb);
298}
299
300static int simple_io (
301 struct urb *urb,
302 int iterations,
303 int vary,
304 int expected,
305 const char *label
306)
307{
308 struct usb_device *udev = urb->dev;
309 int max = urb->transfer_buffer_length;
310 struct completion completion;
311 int retval = 0;
312
313 urb->context = &completion;
314 while (retval == 0 && iterations-- > 0) {
315 init_completion (&completion);
316 if (usb_pipeout (urb->pipe))
317 simple_fill_buf (urb);
318 if ((retval = usb_submit_urb (urb, SLAB_KERNEL)) != 0)
319 break;
320
321 /* NOTE: no timeouts; can't be broken out of by interrupt */
322 wait_for_completion (&completion);
323 retval = urb->status;
324 urb->dev = udev;
325 if (retval == 0 && usb_pipein (urb->pipe))
326 retval = simple_check_buf (urb);
327
328 if (vary) {
329 int len = urb->transfer_buffer_length;
330
331 len += vary;
332 len %= max;
333 if (len == 0)
334 len = (vary < max) ? vary : max;
335 urb->transfer_buffer_length = len;
336 }
337
338 /* FIXME if endpoint halted, clear halt (and log) */
339 }
340 urb->transfer_buffer_length = max;
341
342 if (expected != retval)
343 dev_dbg (&udev->dev,
344 "%s failed, iterations left %d, status %d (not %d)\n",
345 label, iterations, retval, expected);
346 return retval;
347}
348
349
350/*-------------------------------------------------------------------------*/
351
352/* We use scatterlist primitives to test queued I/O.
353 * Yes, this also tests the scatterlist primitives.
354 */
355
356static void free_sglist (struct scatterlist *sg, int nents)
357{
358 unsigned i;
359
360 if (!sg)
361 return;
362 for (i = 0; i < nents; i++) {
363 if (!sg [i].page)
364 continue;
365 kfree (page_address (sg [i].page) + sg [i].offset);
366 }
367 kfree (sg);
368}
369
370static struct scatterlist *
371alloc_sglist (int nents, int max, int vary)
372{
373 struct scatterlist *sg;
374 unsigned i;
375 unsigned size = max;
376
377 sg = kmalloc (nents * sizeof *sg, SLAB_KERNEL);
378 if (!sg)
379 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381 for (i = 0; i < nents; i++) {
382 char *buf;
David Brownell8b524902006-04-02 10:20:15 -0800383 unsigned j;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +0100385 buf = kzalloc (size, SLAB_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 if (!buf) {
387 free_sglist (sg, i);
388 return NULL;
389 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 /* kmalloc pages are always physically contiguous! */
David Hardeman378f0582005-09-17 17:55:31 +1000392 sg_init_one(&sg[i], buf, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
David Brownell8b524902006-04-02 10:20:15 -0800394 switch (pattern) {
395 case 0:
396 /* already zeroed */
397 break;
398 case 1:
399 for (j = 0; j < size; j++)
400 *buf++ = (u8) (j % 63);
401 break;
402 }
403
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 if (vary) {
405 size += vary;
406 size %= max;
407 if (size == 0)
408 size = (vary < max) ? vary : max;
409 }
410 }
411
412 return sg;
413}
414
415static int perform_sglist (
416 struct usb_device *udev,
417 unsigned iterations,
418 int pipe,
419 struct usb_sg_request *req,
420 struct scatterlist *sg,
421 int nents
422)
423{
424 int retval = 0;
425
426 while (retval == 0 && iterations-- > 0) {
427 retval = usb_sg_init (req, udev, pipe,
428 (udev->speed == USB_SPEED_HIGH)
429 ? (INTERRUPT_RATE << 3)
430 : INTERRUPT_RATE,
431 sg, nents, 0, SLAB_KERNEL);
432
433 if (retval)
434 break;
435 usb_sg_wait (req);
436 retval = req->status;
437
David Brownell8b524902006-04-02 10:20:15 -0800438 /* FIXME check resulting data pattern */
439
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 /* FIXME if endpoint halted, clear halt (and log) */
441 }
442
443 // FIXME for unlink or fault handling tests, don't report
444 // failure if retval is as we expected ...
445
446 if (retval)
447 dbg ("perform_sglist failed, iterations left %d, status %d",
448 iterations, retval);
449 return retval;
450}
451
452
453/*-------------------------------------------------------------------------*/
454
455/* unqueued control message testing
456 *
457 * there's a nice set of device functional requirements in chapter 9 of the
458 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
459 * special test firmware.
460 *
461 * we know the device is configured (or suspended) by the time it's visible
462 * through usbfs. we can't change that, so we won't test enumeration (which
463 * worked 'well enough' to get here, this time), power management (ditto),
464 * or remote wakeup (which needs human interaction).
465 */
466
467static unsigned realworld = 1;
468module_param (realworld, uint, 0);
David Brownellff7c79e2005-04-22 13:17:00 -0700469MODULE_PARM_DESC (realworld, "clear to demand stricter spec compliance");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
471static int get_altsetting (struct usbtest_dev *dev)
472{
473 struct usb_interface *iface = dev->intf;
474 struct usb_device *udev = interface_to_usbdev (iface);
475 int retval;
476
477 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
478 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
479 0, iface->altsetting [0].desc.bInterfaceNumber,
480 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
481 switch (retval) {
482 case 1:
483 return dev->buf [0];
484 case 0:
485 retval = -ERANGE;
486 // FALLTHROUGH
487 default:
488 return retval;
489 }
490}
491
492static int set_altsetting (struct usbtest_dev *dev, int alternate)
493{
494 struct usb_interface *iface = dev->intf;
495 struct usb_device *udev;
496
497 if (alternate < 0 || alternate >= 256)
498 return -EINVAL;
499
500 udev = interface_to_usbdev (iface);
501 return usb_set_interface (udev,
502 iface->altsetting [0].desc.bInterfaceNumber,
503 alternate);
504}
505
506static int is_good_config (char *buf, int len)
507{
508 struct usb_config_descriptor *config;
509
510 if (len < sizeof *config)
511 return 0;
512 config = (struct usb_config_descriptor *) buf;
513
514 switch (config->bDescriptorType) {
515 case USB_DT_CONFIG:
516 case USB_DT_OTHER_SPEED_CONFIG:
517 if (config->bLength != 9) {
518 dbg ("bogus config descriptor length");
519 return 0;
520 }
521 /* this bit 'must be 1' but often isn't */
522 if (!realworld && !(config->bmAttributes & 0x80)) {
523 dbg ("high bit of config attributes not set");
524 return 0;
525 }
526 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
527 dbg ("reserved config bits set");
528 return 0;
529 }
530 break;
531 default:
532 return 0;
533 }
534
535 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
536 return 1;
537 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
538 return 1;
539 dbg ("bogus config descriptor read size");
540 return 0;
541}
542
543/* sanity test for standard requests working with usb_control_mesg() and some
544 * of the utility functions which use it.
545 *
546 * this doesn't test how endpoint halts behave or data toggles get set, since
547 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
548 * halt or toggle). toggle testing is impractical without support from hcds.
549 *
550 * this avoids failing devices linux would normally work with, by not testing
551 * config/altsetting operations for devices that only support their defaults.
552 * such devices rarely support those needless operations.
553 *
554 * NOTE that since this is a sanity test, it's not examining boundary cases
555 * to see if usbcore, hcd, and device all behave right. such testing would
556 * involve varied read sizes and other operation sequences.
557 */
558static int ch9_postconfig (struct usbtest_dev *dev)
559{
560 struct usb_interface *iface = dev->intf;
561 struct usb_device *udev = interface_to_usbdev (iface);
562 int i, alt, retval;
563
564 /* [9.2.3] if there's more than one altsetting, we need to be able to
565 * set and get each one. mostly trusts the descriptors from usbcore.
566 */
567 for (i = 0; i < iface->num_altsetting; i++) {
568
569 /* 9.2.3 constrains the range here */
570 alt = iface->altsetting [i].desc.bAlternateSetting;
571 if (alt < 0 || alt >= iface->num_altsetting) {
572 dev_dbg (&iface->dev,
573 "invalid alt [%d].bAltSetting = %d\n",
574 i, alt);
575 }
576
577 /* [real world] get/set unimplemented if there's only one */
578 if (realworld && iface->num_altsetting == 1)
579 continue;
580
581 /* [9.4.10] set_interface */
582 retval = set_altsetting (dev, alt);
583 if (retval) {
584 dev_dbg (&iface->dev, "can't set_interface = %d, %d\n",
585 alt, retval);
586 return retval;
587 }
588
589 /* [9.4.4] get_interface always works */
590 retval = get_altsetting (dev);
591 if (retval != alt) {
592 dev_dbg (&iface->dev, "get alt should be %d, was %d\n",
593 alt, retval);
594 return (retval < 0) ? retval : -EDOM;
595 }
596
597 }
598
599 /* [real world] get_config unimplemented if there's only one */
600 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
601 int expected = udev->actconfig->desc.bConfigurationValue;
602
603 /* [9.4.2] get_configuration always works
604 * ... although some cheap devices (like one TI Hub I've got)
605 * won't return config descriptors except before set_config.
606 */
607 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
608 USB_REQ_GET_CONFIGURATION,
609 USB_DIR_IN | USB_RECIP_DEVICE,
610 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
611 if (retval != 1 || dev->buf [0] != expected) {
David Brownellff7c79e2005-04-22 13:17:00 -0700612 dev_dbg (&iface->dev, "get config --> %d %d (1 %d)\n",
613 retval, dev->buf[0], expected);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 return (retval < 0) ? retval : -EDOM;
615 }
616 }
617
618 /* there's always [9.4.3] a device descriptor [9.6.1] */
619 retval = usb_get_descriptor (udev, USB_DT_DEVICE, 0,
620 dev->buf, sizeof udev->descriptor);
621 if (retval != sizeof udev->descriptor) {
622 dev_dbg (&iface->dev, "dev descriptor --> %d\n", retval);
623 return (retval < 0) ? retval : -EDOM;
624 }
625
626 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
627 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
628 retval = usb_get_descriptor (udev, USB_DT_CONFIG, i,
629 dev->buf, TBUF_SIZE);
630 if (!is_good_config (dev->buf, retval)) {
631 dev_dbg (&iface->dev,
632 "config [%d] descriptor --> %d\n",
633 i, retval);
634 return (retval < 0) ? retval : -EDOM;
635 }
636
637 // FIXME cross-checking udev->config[i] to make sure usbcore
638 // parsed it right (etc) would be good testing paranoia
639 }
640
641 /* and sometimes [9.2.6.6] speed dependent descriptors */
642 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
643 struct usb_qualifier_descriptor *d = NULL;
644
645 /* device qualifier [9.6.2] */
646 retval = usb_get_descriptor (udev,
647 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
648 sizeof (struct usb_qualifier_descriptor));
649 if (retval == -EPIPE) {
650 if (udev->speed == USB_SPEED_HIGH) {
651 dev_dbg (&iface->dev,
652 "hs dev qualifier --> %d\n",
653 retval);
654 return (retval < 0) ? retval : -EDOM;
655 }
656 /* usb2.0 but not high-speed capable; fine */
657 } else if (retval != sizeof (struct usb_qualifier_descriptor)) {
658 dev_dbg (&iface->dev, "dev qualifier --> %d\n", retval);
659 return (retval < 0) ? retval : -EDOM;
660 } else
661 d = (struct usb_qualifier_descriptor *) dev->buf;
662
663 /* might not have [9.6.2] any other-speed configs [9.6.4] */
664 if (d) {
665 unsigned max = d->bNumConfigurations;
666 for (i = 0; i < max; i++) {
667 retval = usb_get_descriptor (udev,
668 USB_DT_OTHER_SPEED_CONFIG, i,
669 dev->buf, TBUF_SIZE);
670 if (!is_good_config (dev->buf, retval)) {
671 dev_dbg (&iface->dev,
672 "other speed config --> %d\n",
673 retval);
674 return (retval < 0) ? retval : -EDOM;
675 }
676 }
677 }
678 }
679 // FIXME fetch strings from at least the device descriptor
680
681 /* [9.4.5] get_status always works */
682 retval = usb_get_status (udev, USB_RECIP_DEVICE, 0, dev->buf);
683 if (retval != 2) {
684 dev_dbg (&iface->dev, "get dev status --> %d\n", retval);
685 return (retval < 0) ? retval : -EDOM;
686 }
687
688 // FIXME configuration.bmAttributes says if we could try to set/clear
689 // the device's remote wakeup feature ... if we can, test that here
690
691 retval = usb_get_status (udev, USB_RECIP_INTERFACE,
692 iface->altsetting [0].desc.bInterfaceNumber, dev->buf);
693 if (retval != 2) {
694 dev_dbg (&iface->dev, "get interface status --> %d\n", retval);
695 return (retval < 0) ? retval : -EDOM;
696 }
697 // FIXME get status for each endpoint in the interface
698
699 return 0;
700}
701
702/*-------------------------------------------------------------------------*/
703
704/* use ch9 requests to test whether:
705 * (a) queues work for control, keeping N subtests queued and
706 * active (auto-resubmit) for M loops through the queue.
707 * (b) protocol stalls (control-only) will autorecover.
708 * it's not like bulk/intr; no halt clearing.
709 * (c) short control reads are reported and handled.
710 * (d) queues are always processed in-order
711 */
712
713struct ctrl_ctx {
714 spinlock_t lock;
715 struct usbtest_dev *dev;
716 struct completion complete;
717 unsigned count;
718 unsigned pending;
719 int status;
720 struct urb **urb;
721 struct usbtest_param *param;
722 int last;
723};
724
725#define NUM_SUBCASES 15 /* how many test subcases here? */
726
727struct subcase {
728 struct usb_ctrlrequest setup;
729 int number;
730 int expected;
731};
732
David Howells7d12e782006-10-05 14:55:46 +0100733static void ctrl_complete (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
735 struct ctrl_ctx *ctx = urb->context;
736 struct usb_ctrlrequest *reqp;
737 struct subcase *subcase;
738 int status = urb->status;
739
740 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
741 subcase = container_of (reqp, struct subcase, setup);
742
743 spin_lock (&ctx->lock);
744 ctx->count--;
745 ctx->pending--;
746
747 /* queue must transfer and complete in fifo order, unless
748 * usb_unlink_urb() is used to unlink something not at the
749 * physical queue head (not tested).
750 */
751 if (subcase->number > 0) {
752 if ((subcase->number - ctx->last) != 1) {
753 dbg ("subcase %d completed out of order, last %d",
754 subcase->number, ctx->last);
755 status = -EDOM;
756 ctx->last = subcase->number;
757 goto error;
758 }
759 }
760 ctx->last = subcase->number;
761
762 /* succeed or fault in only one way? */
763 if (status == subcase->expected)
764 status = 0;
765
766 /* async unlink for cleanup? */
767 else if (status != -ECONNRESET) {
768
769 /* some faults are allowed, not required */
770 if (subcase->expected > 0 && (
771 ((urb->status == -subcase->expected /* happened */
772 || urb->status == 0)))) /* didn't */
773 status = 0;
774 /* sometimes more than one fault is allowed */
775 else if (subcase->number == 12 && status == -EPIPE)
776 status = 0;
777 else
778 dbg ("subtest %d error, status %d",
779 subcase->number, status);
780 }
781
782 /* unexpected status codes mean errors; ideally, in hardware */
783 if (status) {
784error:
785 if (ctx->status == 0) {
786 int i;
787
788 ctx->status = status;
789 info ("control queue %02x.%02x, err %d, %d left",
790 reqp->bRequestType, reqp->bRequest,
791 status, ctx->count);
792
793 /* FIXME this "unlink everything" exit route should
794 * be a separate test case.
795 */
796
797 /* unlink whatever's still pending */
798 for (i = 1; i < ctx->param->sglen; i++) {
799 struct urb *u = ctx->urb [
800 (i + subcase->number) % ctx->param->sglen];
801
802 if (u == urb || !u->dev)
803 continue;
Franck Bui-Huucaa2a122006-05-15 19:23:53 +0200804 spin_unlock(&ctx->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 status = usb_unlink_urb (u);
Franck Bui-Huucaa2a122006-05-15 19:23:53 +0200806 spin_lock(&ctx->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 switch (status) {
808 case -EINPROGRESS:
809 case -EBUSY:
810 case -EIDRM:
811 continue;
812 default:
813 dbg ("urb unlink --> %d", status);
814 }
815 }
816 status = ctx->status;
817 }
818 }
819
820 /* resubmit if we need to, else mark this as done */
821 if ((status == 0) && (ctx->pending < ctx->count)) {
822 if ((status = usb_submit_urb (urb, SLAB_ATOMIC)) != 0) {
823 dbg ("can't resubmit ctrl %02x.%02x, err %d",
824 reqp->bRequestType, reqp->bRequest, status);
825 urb->dev = NULL;
826 } else
827 ctx->pending++;
828 } else
829 urb->dev = NULL;
830
831 /* signal completion when nothing's queued */
832 if (ctx->pending == 0)
833 complete (&ctx->complete);
834 spin_unlock (&ctx->lock);
835}
836
837static int
838test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
839{
840 struct usb_device *udev = testdev_to_usbdev (dev);
841 struct urb **urb;
842 struct ctrl_ctx context;
843 int i;
844
845 spin_lock_init (&context.lock);
846 context.dev = dev;
847 init_completion (&context.complete);
848 context.count = param->sglen * param->iterations;
849 context.pending = 0;
850 context.status = -ENOMEM;
851 context.param = param;
852 context.last = -1;
853
854 /* allocate and init the urbs we'll queue.
855 * as with bulk/intr sglists, sglen is the queue depth; it also
856 * controls which subtests run (more tests than sglen) or rerun.
857 */
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +0100858 urb = kcalloc(param->sglen, sizeof(struct urb *), SLAB_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 if (!urb)
860 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 for (i = 0; i < param->sglen; i++) {
862 int pipe = usb_rcvctrlpipe (udev, 0);
863 unsigned len;
864 struct urb *u;
865 struct usb_ctrlrequest req;
866 struct subcase *reqp;
867 int expected = 0;
868
869 /* requests here are mostly expected to succeed on any
870 * device, but some are chosen to trigger protocol stalls
871 * or short reads.
872 */
873 memset (&req, 0, sizeof req);
874 req.bRequest = USB_REQ_GET_DESCRIPTOR;
875 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
876
877 switch (i % NUM_SUBCASES) {
878 case 0: // get device descriptor
879 req.wValue = cpu_to_le16 (USB_DT_DEVICE << 8);
880 len = sizeof (struct usb_device_descriptor);
881 break;
882 case 1: // get first config descriptor (only)
883 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
884 len = sizeof (struct usb_config_descriptor);
885 break;
886 case 2: // get altsetting (OFTEN STALLS)
887 req.bRequest = USB_REQ_GET_INTERFACE;
888 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
889 // index = 0 means first interface
890 len = 1;
891 expected = EPIPE;
892 break;
893 case 3: // get interface status
894 req.bRequest = USB_REQ_GET_STATUS;
895 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
896 // interface 0
897 len = 2;
898 break;
899 case 4: // get device status
900 req.bRequest = USB_REQ_GET_STATUS;
901 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
902 len = 2;
903 break;
904 case 5: // get device qualifier (MAY STALL)
905 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
906 len = sizeof (struct usb_qualifier_descriptor);
907 if (udev->speed != USB_SPEED_HIGH)
908 expected = EPIPE;
909 break;
910 case 6: // get first config descriptor, plus interface
911 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
912 len = sizeof (struct usb_config_descriptor);
913 len += sizeof (struct usb_interface_descriptor);
914 break;
915 case 7: // get interface descriptor (ALWAYS STALLS)
916 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
917 // interface == 0
918 len = sizeof (struct usb_interface_descriptor);
919 expected = EPIPE;
920 break;
921 // NOTE: two consecutive stalls in the queue here.
922 // that tests fault recovery a bit more aggressively.
923 case 8: // clear endpoint halt (USUALLY STALLS)
924 req.bRequest = USB_REQ_CLEAR_FEATURE;
925 req.bRequestType = USB_RECIP_ENDPOINT;
926 // wValue 0 == ep halt
927 // wIndex 0 == ep0 (shouldn't halt!)
928 len = 0;
929 pipe = usb_sndctrlpipe (udev, 0);
930 expected = EPIPE;
931 break;
932 case 9: // get endpoint status
933 req.bRequest = USB_REQ_GET_STATUS;
934 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
935 // endpoint 0
936 len = 2;
937 break;
938 case 10: // trigger short read (EREMOTEIO)
939 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
940 len = 1024;
941 expected = -EREMOTEIO;
942 break;
943 // NOTE: two consecutive _different_ faults in the queue.
944 case 11: // get endpoint descriptor (ALWAYS STALLS)
945 req.wValue = cpu_to_le16 (USB_DT_ENDPOINT << 8);
946 // endpoint == 0
947 len = sizeof (struct usb_interface_descriptor);
948 expected = EPIPE;
949 break;
950 // NOTE: sometimes even a third fault in the queue!
951 case 12: // get string 0 descriptor (MAY STALL)
952 req.wValue = cpu_to_le16 (USB_DT_STRING << 8);
953 // string == 0, for language IDs
954 len = sizeof (struct usb_interface_descriptor);
955 // may succeed when > 4 languages
956 expected = EREMOTEIO; // or EPIPE, if no strings
957 break;
958 case 13: // short read, resembling case 10
959 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
960 // last data packet "should" be DATA1, not DATA0
961 len = 1024 - udev->descriptor.bMaxPacketSize0;
962 expected = -EREMOTEIO;
963 break;
964 case 14: // short read; try to fill the last packet
965 req.wValue = cpu_to_le16 ((USB_DT_DEVICE << 8) | 0);
966 // device descriptor size == 18 bytes
967 len = udev->descriptor.bMaxPacketSize0;
968 switch (len) {
969 case 8: len = 24; break;
970 case 16: len = 32; break;
971 }
972 expected = -EREMOTEIO;
973 break;
974 default:
975 err ("bogus number of ctrl queue testcases!");
976 context.status = -EINVAL;
977 goto cleanup;
978 }
979 req.wLength = cpu_to_le16 (len);
980 urb [i] = u = simple_alloc_urb (udev, pipe, len);
981 if (!u)
982 goto cleanup;
983
984 reqp = usb_buffer_alloc (udev, sizeof *reqp, SLAB_KERNEL,
985 &u->setup_dma);
986 if (!reqp)
987 goto cleanup;
988 reqp->setup = req;
989 reqp->number = i % NUM_SUBCASES;
990 reqp->expected = expected;
991 u->setup_packet = (char *) &reqp->setup;
Alan Stern3e8a5562005-10-18 10:08:31 -0400992 u->transfer_flags |= URB_NO_SETUP_DMA_MAP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
994 u->context = &context;
995 u->complete = ctrl_complete;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 }
997
998 /* queue the urbs */
999 context.urb = urb;
1000 spin_lock_irq (&context.lock);
1001 for (i = 0; i < param->sglen; i++) {
1002 context.status = usb_submit_urb (urb [i], SLAB_ATOMIC);
1003 if (context.status != 0) {
1004 dbg ("can't submit urb[%d], status %d",
1005 i, context.status);
1006 context.count = context.pending;
1007 break;
1008 }
1009 context.pending++;
1010 }
1011 spin_unlock_irq (&context.lock);
1012
1013 /* FIXME set timer and time out; provide a disconnect hook */
1014
1015 /* wait for the last one to complete */
1016 if (context.pending > 0)
1017 wait_for_completion (&context.complete);
1018
1019cleanup:
1020 for (i = 0; i < param->sglen; i++) {
1021 if (!urb [i])
1022 continue;
1023 urb [i]->dev = udev;
1024 if (urb [i]->setup_packet)
1025 usb_buffer_free (udev, sizeof (struct usb_ctrlrequest),
1026 urb [i]->setup_packet,
1027 urb [i]->setup_dma);
1028 simple_free_urb (urb [i]);
1029 }
1030 kfree (urb);
1031 return context.status;
1032}
1033#undef NUM_SUBCASES
1034
1035
1036/*-------------------------------------------------------------------------*/
1037
David Howells7d12e782006-10-05 14:55:46 +01001038static void unlink1_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039{
1040 int status = urb->status;
1041
1042 // we "know" -EPIPE (stall) never happens
1043 if (!status)
1044 status = usb_submit_urb (urb, SLAB_ATOMIC);
1045 if (status) {
1046 urb->status = status;
1047 complete ((struct completion *) urb->context);
1048 }
1049}
1050
1051static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1052{
1053 struct urb *urb;
1054 struct completion completion;
1055 int retval = 0;
1056
1057 init_completion (&completion);
1058 urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1059 if (!urb)
1060 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 urb->context = &completion;
1062 urb->complete = unlink1_callback;
1063
1064 /* keep the endpoint busy. there are lots of hc/hcd-internal
1065 * states, and testing should get to all of them over time.
1066 *
1067 * FIXME want additional tests for when endpoint is STALLing
1068 * due to errors, or is just NAKing requests.
1069 */
1070 if ((retval = usb_submit_urb (urb, SLAB_KERNEL)) != 0) {
1071 dev_dbg (&dev->intf->dev, "submit fail %d\n", retval);
1072 return retval;
1073 }
1074
1075 /* unlinking that should always work. variable delay tests more
1076 * hcd states and code paths, even with little other system load.
1077 */
1078 msleep (jiffies % (2 * INTERRUPT_RATE));
1079 if (async) {
1080retry:
1081 retval = usb_unlink_urb (urb);
1082 if (retval == -EBUSY || retval == -EIDRM) {
1083 /* we can't unlink urbs while they're completing.
1084 * or if they've completed, and we haven't resubmitted.
1085 * "normal" drivers would prevent resubmission, but
1086 * since we're testing unlink paths, we can't.
1087 */
1088 dev_dbg (&dev->intf->dev, "unlink retry\n");
1089 goto retry;
1090 }
1091 } else
1092 usb_kill_urb (urb);
1093 if (!(retval == 0 || retval == -EINPROGRESS)) {
1094 dev_dbg (&dev->intf->dev, "unlink fail %d\n", retval);
1095 return retval;
1096 }
1097
1098 wait_for_completion (&completion);
1099 retval = urb->status;
1100 simple_free_urb (urb);
1101
1102 if (async)
1103 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1104 else
1105 return (retval == -ENOENT || retval == -EPERM) ?
1106 0 : retval - 2000;
1107}
1108
1109static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1110{
1111 int retval = 0;
1112
1113 /* test sync and async paths */
1114 retval = unlink1 (dev, pipe, len, 1);
1115 if (!retval)
1116 retval = unlink1 (dev, pipe, len, 0);
1117 return retval;
1118}
1119
1120/*-------------------------------------------------------------------------*/
1121
1122static int verify_not_halted (int ep, struct urb *urb)
1123{
1124 int retval;
1125 u16 status;
1126
1127 /* shouldn't look or act halted */
1128 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1129 if (retval < 0) {
1130 dbg ("ep %02x couldn't get no-halt status, %d", ep, retval);
1131 return retval;
1132 }
1133 if (status != 0) {
1134 dbg ("ep %02x bogus status: %04x != 0", ep, status);
1135 return -EINVAL;
1136 }
1137 retval = simple_io (urb, 1, 0, 0, __FUNCTION__);
1138 if (retval != 0)
1139 return -EINVAL;
1140 return 0;
1141}
1142
1143static int verify_halted (int ep, struct urb *urb)
1144{
1145 int retval;
1146 u16 status;
1147
1148 /* should look and act halted */
1149 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1150 if (retval < 0) {
1151 dbg ("ep %02x couldn't get halt status, %d", ep, retval);
1152 return retval;
1153 }
1154 if (status != 1) {
1155 dbg ("ep %02x bogus status: %04x != 1", ep, status);
1156 return -EINVAL;
1157 }
1158 retval = simple_io (urb, 1, 0, -EPIPE, __FUNCTION__);
1159 if (retval != -EPIPE)
1160 return -EINVAL;
1161 retval = simple_io (urb, 1, 0, -EPIPE, "verify_still_halted");
1162 if (retval != -EPIPE)
1163 return -EINVAL;
1164 return 0;
1165}
1166
1167static int test_halt (int ep, struct urb *urb)
1168{
1169 int retval;
1170
1171 /* shouldn't look or act halted now */
1172 retval = verify_not_halted (ep, urb);
1173 if (retval < 0)
1174 return retval;
1175
1176 /* set halt (protocol test only), verify it worked */
1177 retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1178 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1179 USB_ENDPOINT_HALT, ep,
1180 NULL, 0, USB_CTRL_SET_TIMEOUT);
1181 if (retval < 0) {
1182 dbg ("ep %02x couldn't set halt, %d", ep, retval);
1183 return retval;
1184 }
1185 retval = verify_halted (ep, urb);
1186 if (retval < 0)
1187 return retval;
1188
1189 /* clear halt (tests API + protocol), verify it worked */
1190 retval = usb_clear_halt (urb->dev, urb->pipe);
1191 if (retval < 0) {
1192 dbg ("ep %02x couldn't clear halt, %d", ep, retval);
1193 return retval;
1194 }
1195 retval = verify_not_halted (ep, urb);
1196 if (retval < 0)
1197 return retval;
1198
1199 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1200
1201 return 0;
1202}
1203
1204static int halt_simple (struct usbtest_dev *dev)
1205{
1206 int ep;
1207 int retval = 0;
1208 struct urb *urb;
1209
1210 urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1211 if (urb == NULL)
1212 return -ENOMEM;
1213
1214 if (dev->in_pipe) {
1215 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1216 urb->pipe = dev->in_pipe;
1217 retval = test_halt (ep, urb);
1218 if (retval < 0)
1219 goto done;
1220 }
1221
1222 if (dev->out_pipe) {
1223 ep = usb_pipeendpoint (dev->out_pipe);
1224 urb->pipe = dev->out_pipe;
1225 retval = test_halt (ep, urb);
1226 }
1227done:
1228 simple_free_urb (urb);
1229 return retval;
1230}
1231
1232/*-------------------------------------------------------------------------*/
1233
1234/* Control OUT tests use the vendor control requests from Intel's
1235 * USB 2.0 compliance test device: write a buffer, read it back.
1236 *
1237 * Intel's spec only _requires_ that it work for one packet, which
1238 * is pretty weak. Some HCDs place limits here; most devices will
1239 * need to be able to handle more than one OUT data packet. We'll
1240 * try whatever we're told to try.
1241 */
1242static int ctrl_out (struct usbtest_dev *dev,
1243 unsigned count, unsigned length, unsigned vary)
1244{
Orjan Fribergf54fa842006-08-08 23:31:40 -07001245 unsigned i, j, len;
1246 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 u8 *buf;
1248 char *what = "?";
1249 struct usb_device *udev;
Orjan Fribergf54fa842006-08-08 23:31:40 -07001250
David Brownellff7c79e2005-04-22 13:17:00 -07001251 if (length < 1 || length > 0xffff || vary >= length)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 return -EINVAL;
1253
1254 buf = kmalloc(length, SLAB_KERNEL);
1255 if (!buf)
1256 return -ENOMEM;
1257
1258 udev = testdev_to_usbdev (dev);
1259 len = length;
1260 retval = 0;
1261
1262 /* NOTE: hardware might well act differently if we pushed it
1263 * with lots back-to-back queued requests.
1264 */
1265 for (i = 0; i < count; i++) {
1266 /* write patterned data */
1267 for (j = 0; j < len; j++)
1268 buf [j] = i + j;
1269 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1270 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1271 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1272 if (retval != len) {
1273 what = "write";
David Brownellff7c79e2005-04-22 13:17:00 -07001274 if (retval >= 0) {
1275 INFO(dev, "ctrl_out, wlen %d (expected %d)\n",
1276 retval, len);
1277 retval = -EBADMSG;
1278 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 break;
1280 }
1281
1282 /* read it back -- assuming nothing intervened!! */
1283 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1284 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1285 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1286 if (retval != len) {
1287 what = "read";
David Brownellff7c79e2005-04-22 13:17:00 -07001288 if (retval >= 0) {
1289 INFO(dev, "ctrl_out, rlen %d (expected %d)\n",
1290 retval, len);
1291 retval = -EBADMSG;
1292 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 break;
1294 }
1295
1296 /* fail if we can't verify */
1297 for (j = 0; j < len; j++) {
1298 if (buf [j] != (u8) (i + j)) {
1299 INFO (dev, "ctrl_out, byte %d is %d not %d\n",
1300 j, buf [j], (u8) i + j);
1301 retval = -EBADMSG;
1302 break;
1303 }
1304 }
1305 if (retval < 0) {
1306 what = "verify";
1307 break;
1308 }
1309
1310 len += vary;
David Brownellff7c79e2005-04-22 13:17:00 -07001311
1312 /* [real world] the "zero bytes IN" case isn't really used.
1313 * hardware can easily trip up in this wierd case, since its
1314 * status stage is IN, not OUT like other ep0in transfers.
1315 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 if (len > length)
David Brownellff7c79e2005-04-22 13:17:00 -07001317 len = realworld ? 1 : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 }
1319
1320 if (retval < 0)
1321 INFO (dev, "ctrl_out %s failed, code %d, count %d\n",
1322 what, retval, i);
1323
1324 kfree (buf);
1325 return retval;
1326}
1327
1328/*-------------------------------------------------------------------------*/
1329
1330/* ISO tests ... mimics common usage
1331 * - buffer length is split into N packets (mostly maxpacket sized)
1332 * - multi-buffers according to sglen
1333 */
1334
1335struct iso_context {
1336 unsigned count;
1337 unsigned pending;
1338 spinlock_t lock;
1339 struct completion done;
Alan Stern9da21502006-05-22 16:47:13 -04001340 int submit_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 unsigned long errors;
Alan Stern9da21502006-05-22 16:47:13 -04001342 unsigned long packet_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 struct usbtest_dev *dev;
1344};
1345
David Howells7d12e782006-10-05 14:55:46 +01001346static void iso_callback (struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347{
1348 struct iso_context *ctx = urb->context;
1349
1350 spin_lock(&ctx->lock);
1351 ctx->count--;
1352
Alan Stern9da21502006-05-22 16:47:13 -04001353 ctx->packet_count += urb->number_of_packets;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 if (urb->error_count > 0)
1355 ctx->errors += urb->error_count;
Alan Stern9da21502006-05-22 16:47:13 -04001356 else if (urb->status != 0)
1357 ctx->errors += urb->number_of_packets;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358
Alan Stern9da21502006-05-22 16:47:13 -04001359 if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1360 && !ctx->submit_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 int status = usb_submit_urb (urb, GFP_ATOMIC);
1362 switch (status) {
1363 case 0:
1364 goto done;
1365 default:
1366 dev_dbg (&ctx->dev->intf->dev,
1367 "iso resubmit err %d\n",
1368 status);
1369 /* FALLTHROUGH */
1370 case -ENODEV: /* disconnected */
Alan Stern9da21502006-05-22 16:47:13 -04001371 case -ESHUTDOWN: /* endpoint disabled */
1372 ctx->submit_error = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 break;
1374 }
1375 }
1376 simple_free_urb (urb);
1377
1378 ctx->pending--;
1379 if (ctx->pending == 0) {
1380 if (ctx->errors)
1381 dev_dbg (&ctx->dev->intf->dev,
Alan Stern9da21502006-05-22 16:47:13 -04001382 "iso test, %lu errors out of %lu\n",
1383 ctx->errors, ctx->packet_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 complete (&ctx->done);
1385 }
1386done:
1387 spin_unlock(&ctx->lock);
1388}
1389
1390static struct urb *iso_alloc_urb (
1391 struct usb_device *udev,
1392 int pipe,
1393 struct usb_endpoint_descriptor *desc,
1394 long bytes
1395)
1396{
1397 struct urb *urb;
1398 unsigned i, maxp, packets;
1399
1400 if (bytes < 0 || !desc)
1401 return NULL;
1402 maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1403 maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1404 packets = (bytes + maxp - 1) / maxp;
1405
1406 urb = usb_alloc_urb (packets, SLAB_KERNEL);
1407 if (!urb)
1408 return urb;
1409 urb->dev = udev;
1410 urb->pipe = pipe;
1411
1412 urb->number_of_packets = packets;
1413 urb->transfer_buffer_length = bytes;
1414 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, SLAB_KERNEL,
1415 &urb->transfer_dma);
1416 if (!urb->transfer_buffer) {
1417 usb_free_urb (urb);
1418 return NULL;
1419 }
1420 memset (urb->transfer_buffer, 0, bytes);
1421 for (i = 0; i < packets; i++) {
1422 /* here, only the last packet will be short */
1423 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1424 bytes -= urb->iso_frame_desc[i].length;
1425
1426 urb->iso_frame_desc[i].offset = maxp * i;
1427 }
1428
1429 urb->complete = iso_callback;
1430 // urb->context = SET BY CALLER
1431 urb->interval = 1 << (desc->bInterval - 1);
1432 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1433 return urb;
1434}
1435
1436static int
1437test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1438 int pipe, struct usb_endpoint_descriptor *desc)
1439{
1440 struct iso_context context;
1441 struct usb_device *udev;
1442 unsigned i;
1443 unsigned long packets = 0;
Alan Stern9da21502006-05-22 16:47:13 -04001444 int status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 struct urb *urbs[10]; /* FIXME no limit */
1446
1447 if (param->sglen > 10)
1448 return -EDOM;
1449
Alan Stern9da21502006-05-22 16:47:13 -04001450 memset(&context, 0, sizeof context);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 context.count = param->iterations * param->sglen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 context.dev = dev;
1453 init_completion (&context.done);
1454 spin_lock_init (&context.lock);
1455
1456 memset (urbs, 0, sizeof urbs);
1457 udev = testdev_to_usbdev (dev);
1458 dev_dbg (&dev->intf->dev,
1459 "... iso period %d %sframes, wMaxPacket %04x\n",
1460 1 << (desc->bInterval - 1),
1461 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1462 le16_to_cpu(desc->wMaxPacketSize));
1463
1464 for (i = 0; i < param->sglen; i++) {
1465 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1466 param->length);
1467 if (!urbs [i]) {
1468 status = -ENOMEM;
1469 goto fail;
1470 }
1471 packets += urbs[i]->number_of_packets;
1472 urbs [i]->context = &context;
1473 }
1474 packets *= param->iterations;
1475 dev_dbg (&dev->intf->dev,
1476 "... total %lu msec (%lu packets)\n",
1477 (packets * (1 << (desc->bInterval - 1)))
1478 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1479 packets);
1480
1481 spin_lock_irq (&context.lock);
1482 for (i = 0; i < param->sglen; i++) {
Alan Stern9da21502006-05-22 16:47:13 -04001483 ++context.pending;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 status = usb_submit_urb (urbs [i], SLAB_ATOMIC);
1485 if (status < 0) {
1486 ERROR (dev, "submit iso[%d], error %d\n", i, status);
1487 if (i == 0) {
1488 spin_unlock_irq (&context.lock);
1489 goto fail;
1490 }
1491
1492 simple_free_urb (urbs [i]);
1493 context.pending--;
Alan Stern9da21502006-05-22 16:47:13 -04001494 context.submit_error = 1;
1495 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496 }
1497 }
1498 spin_unlock_irq (&context.lock);
1499
1500 wait_for_completion (&context.done);
Alan Stern9da21502006-05-22 16:47:13 -04001501
1502 /*
1503 * Isochronous transfers are expected to fail sometimes. As an
1504 * arbitrary limit, we will report an error if any submissions
1505 * fail or if the transfer failure rate is > 10%.
1506 */
1507 if (status != 0)
1508 ;
1509 else if (context.submit_error)
1510 status = -EACCES;
1511 else if (context.errors > context.packet_count / 10)
1512 status = -EIO;
1513 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514
1515fail:
1516 for (i = 0; i < param->sglen; i++) {
1517 if (urbs [i])
1518 simple_free_urb (urbs [i]);
1519 }
1520 return status;
1521}
1522
1523/*-------------------------------------------------------------------------*/
1524
1525/* We only have this one interface to user space, through usbfs.
1526 * User mode code can scan usbfs to find N different devices (maybe on
1527 * different busses) to use when testing, and allocate one thread per
1528 * test. So discovery is simplified, and we have no device naming issues.
1529 *
1530 * Don't use these only as stress/load tests. Use them along with with
1531 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1532 * video capture, and so on. Run different tests at different times, in
1533 * different sequences. Nothing here should interact with other devices,
1534 * except indirectly by consuming USB bandwidth and CPU resources for test
1535 * threads and request completion. But the only way to know that for sure
1536 * is to test when HC queues are in use by many devices.
1537 */
1538
1539static int
1540usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1541{
1542 struct usbtest_dev *dev = usb_get_intfdata (intf);
1543 struct usb_device *udev = testdev_to_usbdev (dev);
1544 struct usbtest_param *param = buf;
1545 int retval = -EOPNOTSUPP;
1546 struct urb *urb;
1547 struct scatterlist *sg;
1548 struct usb_sg_request req;
1549 struct timeval start;
1550 unsigned i;
1551
1552 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1553
1554 if (code != USBTEST_REQUEST)
1555 return -EOPNOTSUPP;
1556
1557 if (param->iterations <= 0 || param->length < 0
1558 || param->sglen < 0 || param->vary < 0)
1559 return -EINVAL;
1560
1561 if (down_interruptible (&dev->sem))
1562 return -ERESTARTSYS;
1563
Pavel Machekca078ba2005-09-03 15:56:57 -07001564 if (intf->dev.power.power_state.event != PM_EVENT_ON) {
David Brownellff7c79e2005-04-22 13:17:00 -07001565 up (&dev->sem);
1566 return -EHOSTUNREACH;
1567 }
1568
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 /* some devices, like ez-usb default devices, need a non-default
1570 * altsetting to have any active endpoints. some tests change
1571 * altsettings; force a default so most tests don't need to check.
1572 */
1573 if (dev->info->alt >= 0) {
1574 int res;
1575
1576 if (intf->altsetting->desc.bInterfaceNumber) {
1577 up (&dev->sem);
1578 return -ENODEV;
1579 }
1580 res = set_altsetting (dev, dev->info->alt);
1581 if (res) {
1582 dev_err (&intf->dev,
1583 "set altsetting to %d failed, %d\n",
1584 dev->info->alt, res);
1585 up (&dev->sem);
1586 return res;
1587 }
1588 }
1589
1590 /*
1591 * Just a bunch of test cases that every HCD is expected to handle.
1592 *
1593 * Some may need specific firmware, though it'd be good to have
1594 * one firmware image to handle all the test cases.
1595 *
1596 * FIXME add more tests! cancel requests, verify the data, control
1597 * queueing, concurrent read+write threads, and so on.
1598 */
1599 do_gettimeofday (&start);
1600 switch (param->test_num) {
1601
1602 case 0:
1603 dev_dbg (&intf->dev, "TEST 0: NOP\n");
1604 retval = 0;
1605 break;
1606
1607 /* Simple non-queued bulk I/O tests */
1608 case 1:
1609 if (dev->out_pipe == 0)
1610 break;
1611 dev_dbg (&intf->dev,
1612 "TEST 1: write %d bytes %u times\n",
1613 param->length, param->iterations);
1614 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1615 if (!urb) {
1616 retval = -ENOMEM;
1617 break;
1618 }
1619 // FIRMWARE: bulk sink (maybe accepts short writes)
1620 retval = simple_io (urb, param->iterations, 0, 0, "test1");
1621 simple_free_urb (urb);
1622 break;
1623 case 2:
1624 if (dev->in_pipe == 0)
1625 break;
1626 dev_dbg (&intf->dev,
1627 "TEST 2: read %d bytes %u times\n",
1628 param->length, param->iterations);
1629 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1630 if (!urb) {
1631 retval = -ENOMEM;
1632 break;
1633 }
1634 // FIRMWARE: bulk source (maybe generates short writes)
1635 retval = simple_io (urb, param->iterations, 0, 0, "test2");
1636 simple_free_urb (urb);
1637 break;
1638 case 3:
1639 if (dev->out_pipe == 0 || param->vary == 0)
1640 break;
1641 dev_dbg (&intf->dev,
1642 "TEST 3: write/%d 0..%d bytes %u times\n",
1643 param->vary, param->length, param->iterations);
1644 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1645 if (!urb) {
1646 retval = -ENOMEM;
1647 break;
1648 }
1649 // FIRMWARE: bulk sink (maybe accepts short writes)
1650 retval = simple_io (urb, param->iterations, param->vary,
1651 0, "test3");
1652 simple_free_urb (urb);
1653 break;
1654 case 4:
1655 if (dev->in_pipe == 0 || param->vary == 0)
1656 break;
1657 dev_dbg (&intf->dev,
1658 "TEST 4: read/%d 0..%d bytes %u times\n",
1659 param->vary, param->length, param->iterations);
1660 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1661 if (!urb) {
1662 retval = -ENOMEM;
1663 break;
1664 }
1665 // FIRMWARE: bulk source (maybe generates short writes)
1666 retval = simple_io (urb, param->iterations, param->vary,
1667 0, "test4");
1668 simple_free_urb (urb);
1669 break;
1670
1671 /* Queued bulk I/O tests */
1672 case 5:
1673 if (dev->out_pipe == 0 || param->sglen == 0)
1674 break;
1675 dev_dbg (&intf->dev,
1676 "TEST 5: write %d sglists %d entries of %d bytes\n",
1677 param->iterations,
1678 param->sglen, param->length);
1679 sg = alloc_sglist (param->sglen, param->length, 0);
1680 if (!sg) {
1681 retval = -ENOMEM;
1682 break;
1683 }
1684 // FIRMWARE: bulk sink (maybe accepts short writes)
1685 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1686 &req, sg, param->sglen);
1687 free_sglist (sg, param->sglen);
1688 break;
1689
1690 case 6:
1691 if (dev->in_pipe == 0 || param->sglen == 0)
1692 break;
1693 dev_dbg (&intf->dev,
1694 "TEST 6: read %d sglists %d entries of %d bytes\n",
1695 param->iterations,
1696 param->sglen, param->length);
1697 sg = alloc_sglist (param->sglen, param->length, 0);
1698 if (!sg) {
1699 retval = -ENOMEM;
1700 break;
1701 }
1702 // FIRMWARE: bulk source (maybe generates short writes)
1703 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1704 &req, sg, param->sglen);
1705 free_sglist (sg, param->sglen);
1706 break;
1707 case 7:
1708 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1709 break;
1710 dev_dbg (&intf->dev,
1711 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1712 param->vary, param->iterations,
1713 param->sglen, param->length);
1714 sg = alloc_sglist (param->sglen, param->length, param->vary);
1715 if (!sg) {
1716 retval = -ENOMEM;
1717 break;
1718 }
1719 // FIRMWARE: bulk sink (maybe accepts short writes)
1720 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1721 &req, sg, param->sglen);
1722 free_sglist (sg, param->sglen);
1723 break;
1724 case 8:
1725 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1726 break;
1727 dev_dbg (&intf->dev,
1728 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1729 param->vary, param->iterations,
1730 param->sglen, param->length);
1731 sg = alloc_sglist (param->sglen, param->length, param->vary);
1732 if (!sg) {
1733 retval = -ENOMEM;
1734 break;
1735 }
1736 // FIRMWARE: bulk source (maybe generates short writes)
1737 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1738 &req, sg, param->sglen);
1739 free_sglist (sg, param->sglen);
1740 break;
1741
1742 /* non-queued sanity tests for control (chapter 9 subset) */
1743 case 9:
1744 retval = 0;
1745 dev_dbg (&intf->dev,
1746 "TEST 9: ch9 (subset) control tests, %d times\n",
1747 param->iterations);
1748 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1749 retval = ch9_postconfig (dev);
1750 if (retval)
1751 dbg ("ch9 subset failed, iterations left %d", i);
1752 break;
1753
1754 /* queued control messaging */
1755 case 10:
1756 if (param->sglen == 0)
1757 break;
1758 retval = 0;
1759 dev_dbg (&intf->dev,
1760 "TEST 10: queue %d control calls, %d times\n",
1761 param->sglen,
1762 param->iterations);
1763 retval = test_ctrl_queue (dev, param);
1764 break;
1765
1766 /* simple non-queued unlinks (ring with one urb) */
1767 case 11:
1768 if (dev->in_pipe == 0 || !param->length)
1769 break;
1770 retval = 0;
1771 dev_dbg (&intf->dev, "TEST 11: unlink %d reads of %d\n",
1772 param->iterations, param->length);
1773 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1774 retval = unlink_simple (dev, dev->in_pipe,
1775 param->length);
1776 if (retval)
1777 dev_dbg (&intf->dev, "unlink reads failed %d, "
1778 "iterations left %d\n", retval, i);
1779 break;
1780 case 12:
1781 if (dev->out_pipe == 0 || !param->length)
1782 break;
1783 retval = 0;
1784 dev_dbg (&intf->dev, "TEST 12: unlink %d writes of %d\n",
1785 param->iterations, param->length);
1786 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1787 retval = unlink_simple (dev, dev->out_pipe,
1788 param->length);
1789 if (retval)
1790 dev_dbg (&intf->dev, "unlink writes failed %d, "
1791 "iterations left %d\n", retval, i);
1792 break;
1793
1794 /* ep halt tests */
1795 case 13:
1796 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1797 break;
1798 retval = 0;
1799 dev_dbg (&intf->dev, "TEST 13: set/clear %d halts\n",
1800 param->iterations);
1801 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1802 retval = halt_simple (dev);
1803
1804 if (retval)
1805 DBG (dev, "halts failed, iterations left %d\n", i);
1806 break;
1807
1808 /* control write tests */
1809 case 14:
1810 if (!dev->info->ctrl_out)
1811 break;
David Brownellff7c79e2005-04-22 13:17:00 -07001812 dev_dbg (&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
1813 param->iterations,
1814 realworld ? 1 : 0, param->length,
1815 param->vary);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 retval = ctrl_out (dev, param->iterations,
1817 param->length, param->vary);
1818 break;
1819
1820 /* iso write tests */
1821 case 15:
1822 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1823 break;
1824 dev_dbg (&intf->dev,
1825 "TEST 15: write %d iso, %d entries of %d bytes\n",
1826 param->iterations,
1827 param->sglen, param->length);
1828 // FIRMWARE: iso sink
1829 retval = test_iso_queue (dev, param,
1830 dev->out_iso_pipe, dev->iso_out);
1831 break;
1832
1833 /* iso read tests */
1834 case 16:
1835 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1836 break;
1837 dev_dbg (&intf->dev,
1838 "TEST 16: read %d iso, %d entries of %d bytes\n",
1839 param->iterations,
1840 param->sglen, param->length);
1841 // FIRMWARE: iso source
1842 retval = test_iso_queue (dev, param,
1843 dev->in_iso_pipe, dev->iso_in);
1844 break;
1845
1846 // FIXME unlink from queue (ring with N urbs)
1847
1848 // FIXME scatterlist cancel (needs helper thread)
1849
1850 }
1851 do_gettimeofday (&param->duration);
1852 param->duration.tv_sec -= start.tv_sec;
1853 param->duration.tv_usec -= start.tv_usec;
1854 if (param->duration.tv_usec < 0) {
1855 param->duration.tv_usec += 1000 * 1000;
1856 param->duration.tv_sec -= 1;
1857 }
1858 up (&dev->sem);
1859 return retval;
1860}
1861
1862/*-------------------------------------------------------------------------*/
1863
1864static unsigned force_interrupt = 0;
1865module_param (force_interrupt, uint, 0);
1866MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1867
1868#ifdef GENERIC
1869static unsigned short vendor;
1870module_param(vendor, ushort, 0);
1871MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1872
1873static unsigned short product;
1874module_param(product, ushort, 0);
1875MODULE_PARM_DESC (product, "product code (from vendor)");
1876#endif
1877
1878static int
1879usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1880{
1881 struct usb_device *udev;
1882 struct usbtest_dev *dev;
1883 struct usbtest_info *info;
1884 char *rtest, *wtest;
1885 char *irtest, *iwtest;
1886
1887 udev = interface_to_usbdev (intf);
1888
1889#ifdef GENERIC
1890 /* specify devices by module parameters? */
1891 if (id->match_flags == 0) {
1892 /* vendor match required, product match optional */
1893 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1894 return -ENODEV;
1895 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1896 return -ENODEV;
1897 dbg ("matched module params, vend=0x%04x prod=0x%04x",
1898 le16_to_cpu(udev->descriptor.idVendor),
1899 le16_to_cpu(udev->descriptor.idProduct));
1900 }
1901#endif
1902
Eric Sesterhenn80b6ca42006-02-27 21:29:43 +01001903 dev = kzalloc(sizeof(*dev), SLAB_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 if (!dev)
1905 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 info = (struct usbtest_info *) id->driver_info;
1907 dev->info = info;
1908 init_MUTEX (&dev->sem);
1909
1910 dev->intf = intf;
1911
1912 /* cacheline-aligned scratch for i/o */
1913 if ((dev->buf = kmalloc (TBUF_SIZE, SLAB_KERNEL)) == NULL) {
1914 kfree (dev);
1915 return -ENOMEM;
1916 }
1917
1918 /* NOTE this doesn't yet test the handful of difference that are
1919 * visible with high speed interrupts: bigger maxpacket (1K) and
1920 * "high bandwidth" modes (up to 3 packets/uframe).
1921 */
1922 rtest = wtest = "";
1923 irtest = iwtest = "";
1924 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1925 if (info->ep_in) {
1926 dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1927 rtest = " intr-in";
1928 }
1929 if (info->ep_out) {
1930 dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1931 wtest = " intr-out";
1932 }
1933 } else {
1934 if (info->autoconf) {
1935 int status;
1936
1937 status = get_endpoints (dev, intf);
1938 if (status < 0) {
1939 dbg ("couldn't get endpoints, %d\n", status);
1940 return status;
1941 }
1942 /* may find bulk or ISO pipes */
1943 } else {
1944 if (info->ep_in)
1945 dev->in_pipe = usb_rcvbulkpipe (udev,
1946 info->ep_in);
1947 if (info->ep_out)
1948 dev->out_pipe = usb_sndbulkpipe (udev,
1949 info->ep_out);
1950 }
1951 if (dev->in_pipe)
1952 rtest = " bulk-in";
1953 if (dev->out_pipe)
1954 wtest = " bulk-out";
1955 if (dev->in_iso_pipe)
1956 irtest = " iso-in";
1957 if (dev->out_iso_pipe)
1958 iwtest = " iso-out";
1959 }
1960
1961 usb_set_intfdata (intf, dev);
1962 dev_info (&intf->dev, "%s\n", info->name);
1963 dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1964 ({ char *tmp;
1965 switch (udev->speed) {
1966 case USB_SPEED_LOW: tmp = "low"; break;
1967 case USB_SPEED_FULL: tmp = "full"; break;
1968 case USB_SPEED_HIGH: tmp = "high"; break;
1969 default: tmp = "unknown"; break;
1970 }; tmp; }),
1971 info->ctrl_out ? " in/out" : "",
1972 rtest, wtest,
1973 irtest, iwtest,
1974 info->alt >= 0 ? " (+alt)" : "");
1975 return 0;
1976}
1977
David Brownellff7c79e2005-04-22 13:17:00 -07001978static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1979{
David Brownellff7c79e2005-04-22 13:17:00 -07001980 return 0;
1981}
1982
1983static int usbtest_resume (struct usb_interface *intf)
1984{
David Brownellff7c79e2005-04-22 13:17:00 -07001985 return 0;
1986}
1987
1988
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989static void usbtest_disconnect (struct usb_interface *intf)
1990{
1991 struct usbtest_dev *dev = usb_get_intfdata (intf);
1992
1993 down (&dev->sem);
1994
1995 usb_set_intfdata (intf, NULL);
1996 dev_dbg (&intf->dev, "disconnect\n");
1997 kfree (dev);
1998}
1999
2000/* Basic testing only needs a device that can source or sink bulk traffic.
2001 * Any device can test control transfers (default with GENERIC binding).
2002 *
2003 * Several entries work with the default EP0 implementation that's built
2004 * into EZ-USB chips. There's a default vendor ID which can be overridden
2005 * by (very) small config EEPROMS, but otherwise all these devices act
2006 * identically until firmware is loaded: only EP0 works. It turns out
2007 * to be easy to make other endpoints work, without modifying that EP0
2008 * behavior. For now, we expect that kind of firmware.
2009 */
2010
2011/* an21xx or fx versions of ez-usb */
2012static struct usbtest_info ez1_info = {
2013 .name = "EZ-USB device",
2014 .ep_in = 2,
2015 .ep_out = 2,
2016 .alt = 1,
2017};
2018
2019/* fx2 version of ez-usb */
2020static struct usbtest_info ez2_info = {
2021 .name = "FX2 device",
2022 .ep_in = 6,
2023 .ep_out = 2,
2024 .alt = 1,
2025};
2026
2027/* ezusb family device with dedicated usb test firmware,
2028 */
2029static struct usbtest_info fw_info = {
2030 .name = "usb test device",
2031 .ep_in = 2,
2032 .ep_out = 2,
2033 .alt = 1,
2034 .autoconf = 1, // iso and ctrl_out need autoconf
2035 .ctrl_out = 1,
2036 .iso = 1, // iso_ep's are #8 in/out
2037};
2038
2039/* peripheral running Linux and 'zero.c' test firmware, or
2040 * its user-mode cousin. different versions of this use
2041 * different hardware with the same vendor/product codes.
2042 * host side MUST rely on the endpoint descriptors.
2043 */
2044static struct usbtest_info gz_info = {
2045 .name = "Linux gadget zero",
2046 .autoconf = 1,
2047 .ctrl_out = 1,
2048 .alt = 0,
2049};
2050
2051static struct usbtest_info um_info = {
2052 .name = "Linux user mode test driver",
2053 .autoconf = 1,
2054 .alt = -1,
2055};
2056
2057static struct usbtest_info um2_info = {
2058 .name = "Linux user mode ISO test driver",
2059 .autoconf = 1,
2060 .iso = 1,
2061 .alt = -1,
2062};
2063
2064#ifdef IBOT2
2065/* this is a nice source of high speed bulk data;
2066 * uses an FX2, with firmware provided in the device
2067 */
2068static struct usbtest_info ibot2_info = {
2069 .name = "iBOT2 webcam",
2070 .ep_in = 2,
2071 .alt = -1,
2072};
2073#endif
2074
2075#ifdef GENERIC
2076/* we can use any device to test control traffic */
2077static struct usbtest_info generic_info = {
2078 .name = "Generic USB device",
2079 .alt = -1,
2080};
2081#endif
2082
2083// FIXME remove this
2084static struct usbtest_info hact_info = {
2085 .name = "FX2/hact",
2086 //.ep_in = 6,
2087 .ep_out = 2,
2088 .alt = -1,
2089};
2090
2091
2092static struct usb_device_id id_table [] = {
2093
2094 { USB_DEVICE (0x0547, 0x1002),
2095 .driver_info = (unsigned long) &hact_info,
2096 },
2097
2098 /*-------------------------------------------------------------*/
2099
2100 /* EZ-USB devices which download firmware to replace (or in our
2101 * case augment) the default device implementation.
2102 */
2103
2104 /* generic EZ-USB FX controller */
2105 { USB_DEVICE (0x0547, 0x2235),
2106 .driver_info = (unsigned long) &ez1_info,
2107 },
2108
2109 /* CY3671 development board with EZ-USB FX */
2110 { USB_DEVICE (0x0547, 0x0080),
2111 .driver_info = (unsigned long) &ez1_info,
2112 },
2113
2114 /* generic EZ-USB FX2 controller (or development board) */
2115 { USB_DEVICE (0x04b4, 0x8613),
2116 .driver_info = (unsigned long) &ez2_info,
2117 },
2118
2119 /* re-enumerated usb test device firmware */
2120 { USB_DEVICE (0xfff0, 0xfff0),
2121 .driver_info = (unsigned long) &fw_info,
2122 },
2123
2124 /* "Gadget Zero" firmware runs under Linux */
2125 { USB_DEVICE (0x0525, 0xa4a0),
2126 .driver_info = (unsigned long) &gz_info,
2127 },
2128
2129 /* so does a user-mode variant */
2130 { USB_DEVICE (0x0525, 0xa4a4),
2131 .driver_info = (unsigned long) &um_info,
2132 },
2133
2134 /* ... and a user-mode variant that talks iso */
2135 { USB_DEVICE (0x0525, 0xa4a3),
2136 .driver_info = (unsigned long) &um2_info,
2137 },
2138
2139#ifdef KEYSPAN_19Qi
2140 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2141 // this does not coexist with the real Keyspan 19qi driver!
2142 { USB_DEVICE (0x06cd, 0x010b),
2143 .driver_info = (unsigned long) &ez1_info,
2144 },
2145#endif
2146
2147 /*-------------------------------------------------------------*/
2148
2149#ifdef IBOT2
2150 /* iBOT2 makes a nice source of high speed bulk-in data */
2151 // this does not coexist with a real iBOT2 driver!
2152 { USB_DEVICE (0x0b62, 0x0059),
2153 .driver_info = (unsigned long) &ibot2_info,
2154 },
2155#endif
2156
2157 /*-------------------------------------------------------------*/
2158
2159#ifdef GENERIC
2160 /* module params can specify devices to use for control tests */
2161 { .driver_info = (unsigned long) &generic_info, },
2162#endif
2163
2164 /*-------------------------------------------------------------*/
2165
2166 { }
2167};
2168MODULE_DEVICE_TABLE (usb, id_table);
2169
2170static struct usb_driver usbtest_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 .name = "usbtest",
2172 .id_table = id_table,
2173 .probe = usbtest_probe,
2174 .ioctl = usbtest_ioctl,
2175 .disconnect = usbtest_disconnect,
David Brownellff7c79e2005-04-22 13:17:00 -07002176 .suspend = usbtest_suspend,
2177 .resume = usbtest_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178};
2179
2180/*-------------------------------------------------------------------------*/
2181
2182static int __init usbtest_init (void)
2183{
2184#ifdef GENERIC
2185 if (vendor)
2186 dbg ("params: vend=0x%04x prod=0x%04x", vendor, product);
2187#endif
2188 return usb_register (&usbtest_driver);
2189}
2190module_init (usbtest_init);
2191
2192static void __exit usbtest_exit (void)
2193{
2194 usb_deregister (&usbtest_driver);
2195}
2196module_exit (usbtest_exit);
2197
2198MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2199MODULE_LICENSE ("GPL");
2200