xref: /linux/drivers/usb/misc/usbtest.c (revision 14b42963f64b98ab61fa9723c03d71aa5ef4f862)
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 
10 #include <linux/usb.h>
11 
12 
13 /*-------------------------------------------------------------------------*/
14 
15 // FIXME make these public somewhere; usbdevfs.h?
16 //
17 struct 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 
43 struct 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  */
59 struct 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 
73 static 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 
108 static int
109 get_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 			}
141 			if (e->desc.bEndpointAddress & USB_DIR_IN) {
142 				if (!in)
143 					in = e;
144 			} else {
145 				if (!out)
146 					out = e;
147 			}
148 			continue;
149 try_iso:
150 			if (e->desc.bEndpointAddress & USB_DIR_IN) {
151 				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 
163 found:
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 
201 static void simple_callback (struct urb *urb, struct pt_regs *regs)
202 {
203 	complete ((struct completion *) urb->context);
204 }
205 
206 static 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 
236 static unsigned pattern = 0;
237 module_param (pattern, uint, S_IRUGO);
238 // MODULE_PARM_DESC (pattern, "i/o pattern (0 == zeroes)");
239 
240 static 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 
259 static 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 
293 static 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 
300 static 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 
356 static 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 
370 static struct scatterlist *
371 alloc_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;
380 
381 	for (i = 0; i < nents; i++) {
382 		char		*buf;
383 		unsigned	j;
384 
385 		buf = kzalloc (size, SLAB_KERNEL);
386 		if (!buf) {
387 			free_sglist (sg, i);
388 			return NULL;
389 		}
390 
391 		/* kmalloc pages are always physically contiguous! */
392 		sg_init_one(&sg[i], buf, size);
393 
394 		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 
404 		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 
415 static 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 
438 		/* FIXME check resulting data pattern */
439 
440 		/* 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 
467 static unsigned realworld = 1;
468 module_param (realworld, uint, 0);
469 MODULE_PARM_DESC (realworld, "clear to demand stricter spec compliance");
470 
471 static 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 
492 static 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 
506 static 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  */
558 static 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) {
612 			dev_dbg (&iface->dev, "get config --> %d %d (1 %d)\n",
613 				retval, dev->buf[0], expected);
614 			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 
713 struct 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 
727 struct subcase {
728 	struct usb_ctrlrequest	setup;
729 	int			number;
730 	int			expected;
731 };
732 
733 static void ctrl_complete (struct urb *urb, struct pt_regs *regs)
734 {
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) {
784 error:
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;
804 				spin_unlock(&ctx->lock);
805 				status = usb_unlink_urb (u);
806 				spin_lock(&ctx->lock);
807 				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 
837 static int
838 test_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 	 */
858 	urb = kcalloc(param->sglen, sizeof(struct urb *), SLAB_KERNEL);
859 	if (!urb)
860 		return -ENOMEM;
861 	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;
992 		u->transfer_flags |= URB_NO_SETUP_DMA_MAP;
993 
994 		u->context = &context;
995 		u->complete = ctrl_complete;
996 	}
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 
1019 cleanup:
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 
1038 static void unlink1_callback (struct urb *urb, struct pt_regs *regs)
1039 {
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 
1051 static 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;
1061 	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) {
1080 retry:
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 
1109 static 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 
1122 static 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 
1143 static 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 
1167 static 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 
1204 static 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 	}
1227 done:
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  */
1242 static int ctrl_out (struct usbtest_dev *dev,
1243 		unsigned count, unsigned length, unsigned vary)
1244 {
1245 	unsigned		i, j, len, retval;
1246 	u8			*buf;
1247 	char			*what = "?";
1248 	struct usb_device	*udev;
1249 
1250 	if (length < 1 || length > 0xffff || vary >= length)
1251 		return -EINVAL;
1252 
1253 	buf = kmalloc(length, SLAB_KERNEL);
1254 	if (!buf)
1255 		return -ENOMEM;
1256 
1257 	udev = testdev_to_usbdev (dev);
1258 	len = length;
1259 	retval = 0;
1260 
1261 	/* NOTE:  hardware might well act differently if we pushed it
1262 	 * with lots back-to-back queued requests.
1263 	 */
1264 	for (i = 0; i < count; i++) {
1265 		/* write patterned data */
1266 		for (j = 0; j < len; j++)
1267 			buf [j] = i + j;
1268 		retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1269 				0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1270 				0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1271 		if (retval != len) {
1272 			what = "write";
1273 			if (retval >= 0) {
1274 				INFO(dev, "ctrl_out, wlen %d (expected %d)\n",
1275 						retval, len);
1276 				retval = -EBADMSG;
1277 			}
1278 			break;
1279 		}
1280 
1281 		/* read it back -- assuming nothing intervened!!  */
1282 		retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1283 				0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1284 				0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1285 		if (retval != len) {
1286 			what = "read";
1287 			if (retval >= 0) {
1288 				INFO(dev, "ctrl_out, rlen %d (expected %d)\n",
1289 						retval, len);
1290 				retval = -EBADMSG;
1291 			}
1292 			break;
1293 		}
1294 
1295 		/* fail if we can't verify */
1296 		for (j = 0; j < len; j++) {
1297 			if (buf [j] != (u8) (i + j)) {
1298 				INFO (dev, "ctrl_out, byte %d is %d not %d\n",
1299 					j, buf [j], (u8) i + j);
1300 				retval = -EBADMSG;
1301 				break;
1302 			}
1303 		}
1304 		if (retval < 0) {
1305 			what = "verify";
1306 			break;
1307 		}
1308 
1309 		len += vary;
1310 
1311 		/* [real world] the "zero bytes IN" case isn't really used.
1312 		 * hardware can easily trip up in this wierd case, since its
1313 		 * status stage is IN, not OUT like other ep0in transfers.
1314 		 */
1315 		if (len > length)
1316 			len = realworld ? 1 : 0;
1317 	}
1318 
1319 	if (retval < 0)
1320 		INFO (dev, "ctrl_out %s failed, code %d, count %d\n",
1321 			what, retval, i);
1322 
1323 	kfree (buf);
1324 	return retval;
1325 }
1326 
1327 /*-------------------------------------------------------------------------*/
1328 
1329 /* ISO tests ... mimics common usage
1330  *  - buffer length is split into N packets (mostly maxpacket sized)
1331  *  - multi-buffers according to sglen
1332  */
1333 
1334 struct iso_context {
1335 	unsigned		count;
1336 	unsigned		pending;
1337 	spinlock_t		lock;
1338 	struct completion	done;
1339 	int			submit_error;
1340 	unsigned long		errors;
1341 	unsigned long		packet_count;
1342 	struct usbtest_dev	*dev;
1343 };
1344 
1345 static void iso_callback (struct urb *urb, struct pt_regs *regs)
1346 {
1347 	struct iso_context	*ctx = urb->context;
1348 
1349 	spin_lock(&ctx->lock);
1350 	ctx->count--;
1351 
1352 	ctx->packet_count += urb->number_of_packets;
1353 	if (urb->error_count > 0)
1354 		ctx->errors += urb->error_count;
1355 	else if (urb->status != 0)
1356 		ctx->errors += urb->number_of_packets;
1357 
1358 	if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1359 			&& !ctx->submit_error) {
1360 		int status = usb_submit_urb (urb, GFP_ATOMIC);
1361 		switch (status) {
1362 		case 0:
1363 			goto done;
1364 		default:
1365 			dev_dbg (&ctx->dev->intf->dev,
1366 					"iso resubmit err %d\n",
1367 					status);
1368 			/* FALLTHROUGH */
1369 		case -ENODEV:			/* disconnected */
1370 		case -ESHUTDOWN:		/* endpoint disabled */
1371 			ctx->submit_error = 1;
1372 			break;
1373 		}
1374 	}
1375 	simple_free_urb (urb);
1376 
1377 	ctx->pending--;
1378 	if (ctx->pending == 0) {
1379 		if (ctx->errors)
1380 			dev_dbg (&ctx->dev->intf->dev,
1381 				"iso test, %lu errors out of %lu\n",
1382 				ctx->errors, ctx->packet_count);
1383 		complete (&ctx->done);
1384 	}
1385 done:
1386 	spin_unlock(&ctx->lock);
1387 }
1388 
1389 static struct urb *iso_alloc_urb (
1390 	struct usb_device	*udev,
1391 	int			pipe,
1392 	struct usb_endpoint_descriptor	*desc,
1393 	long			bytes
1394 )
1395 {
1396 	struct urb		*urb;
1397 	unsigned		i, maxp, packets;
1398 
1399 	if (bytes < 0 || !desc)
1400 		return NULL;
1401 	maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1402 	maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1403 	packets = (bytes + maxp - 1) / maxp;
1404 
1405 	urb = usb_alloc_urb (packets, SLAB_KERNEL);
1406 	if (!urb)
1407 		return urb;
1408 	urb->dev = udev;
1409 	urb->pipe = pipe;
1410 
1411 	urb->number_of_packets = packets;
1412 	urb->transfer_buffer_length = bytes;
1413 	urb->transfer_buffer = usb_buffer_alloc (udev, bytes, SLAB_KERNEL,
1414 			&urb->transfer_dma);
1415 	if (!urb->transfer_buffer) {
1416 		usb_free_urb (urb);
1417 		return NULL;
1418 	}
1419 	memset (urb->transfer_buffer, 0, bytes);
1420 	for (i = 0; i < packets; i++) {
1421 		/* here, only the last packet will be short */
1422 		urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1423 		bytes -= urb->iso_frame_desc[i].length;
1424 
1425 		urb->iso_frame_desc[i].offset = maxp * i;
1426 	}
1427 
1428 	urb->complete = iso_callback;
1429 	// urb->context = SET BY CALLER
1430 	urb->interval = 1 << (desc->bInterval - 1);
1431 	urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1432 	return urb;
1433 }
1434 
1435 static int
1436 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1437 		int pipe, struct usb_endpoint_descriptor *desc)
1438 {
1439 	struct iso_context	context;
1440 	struct usb_device	*udev;
1441 	unsigned		i;
1442 	unsigned long		packets = 0;
1443 	int			status = 0;
1444 	struct urb		*urbs[10];	/* FIXME no limit */
1445 
1446 	if (param->sglen > 10)
1447 		return -EDOM;
1448 
1449 	memset(&context, 0, sizeof context);
1450 	context.count = param->iterations * param->sglen;
1451 	context.dev = dev;
1452 	init_completion (&context.done);
1453 	spin_lock_init (&context.lock);
1454 
1455 	memset (urbs, 0, sizeof urbs);
1456 	udev = testdev_to_usbdev (dev);
1457 	dev_dbg (&dev->intf->dev,
1458 		"... iso period %d %sframes, wMaxPacket %04x\n",
1459 		1 << (desc->bInterval - 1),
1460 		(udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1461 		le16_to_cpu(desc->wMaxPacketSize));
1462 
1463 	for (i = 0; i < param->sglen; i++) {
1464 		urbs [i] = iso_alloc_urb (udev, pipe, desc,
1465 				param->length);
1466 		if (!urbs [i]) {
1467 			status = -ENOMEM;
1468 			goto fail;
1469 		}
1470 		packets += urbs[i]->number_of_packets;
1471 		urbs [i]->context = &context;
1472 	}
1473 	packets *= param->iterations;
1474 	dev_dbg (&dev->intf->dev,
1475 		"... total %lu msec (%lu packets)\n",
1476 		(packets * (1 << (desc->bInterval - 1)))
1477 			/ ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1478 		packets);
1479 
1480 	spin_lock_irq (&context.lock);
1481 	for (i = 0; i < param->sglen; i++) {
1482 		++context.pending;
1483 		status = usb_submit_urb (urbs [i], SLAB_ATOMIC);
1484 		if (status < 0) {
1485 			ERROR (dev, "submit iso[%d], error %d\n", i, status);
1486 			if (i == 0) {
1487 				spin_unlock_irq (&context.lock);
1488 				goto fail;
1489 			}
1490 
1491 			simple_free_urb (urbs [i]);
1492 			context.pending--;
1493 			context.submit_error = 1;
1494 			break;
1495 		}
1496 	}
1497 	spin_unlock_irq (&context.lock);
1498 
1499 	wait_for_completion (&context.done);
1500 
1501 	/*
1502 	 * Isochronous transfers are expected to fail sometimes.  As an
1503 	 * arbitrary limit, we will report an error if any submissions
1504 	 * fail or if the transfer failure rate is > 10%.
1505 	 */
1506 	if (status != 0)
1507 		;
1508 	else if (context.submit_error)
1509 		status = -EACCES;
1510 	else if (context.errors > context.packet_count / 10)
1511 		status = -EIO;
1512 	return status;
1513 
1514 fail:
1515 	for (i = 0; i < param->sglen; i++) {
1516 		if (urbs [i])
1517 			simple_free_urb (urbs [i]);
1518 	}
1519 	return status;
1520 }
1521 
1522 /*-------------------------------------------------------------------------*/
1523 
1524 /* We only have this one interface to user space, through usbfs.
1525  * User mode code can scan usbfs to find N different devices (maybe on
1526  * different busses) to use when testing, and allocate one thread per
1527  * test.  So discovery is simplified, and we have no device naming issues.
1528  *
1529  * Don't use these only as stress/load tests.  Use them along with with
1530  * other USB bus activity:  plugging, unplugging, mousing, mp3 playback,
1531  * video capture, and so on.  Run different tests at different times, in
1532  * different sequences.  Nothing here should interact with other devices,
1533  * except indirectly by consuming USB bandwidth and CPU resources for test
1534  * threads and request completion.  But the only way to know that for sure
1535  * is to test when HC queues are in use by many devices.
1536  */
1537 
1538 static int
1539 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1540 {
1541 	struct usbtest_dev	*dev = usb_get_intfdata (intf);
1542 	struct usb_device	*udev = testdev_to_usbdev (dev);
1543 	struct usbtest_param	*param = buf;
1544 	int			retval = -EOPNOTSUPP;
1545 	struct urb		*urb;
1546 	struct scatterlist	*sg;
1547 	struct usb_sg_request	req;
1548 	struct timeval		start;
1549 	unsigned		i;
1550 
1551 	// FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1552 
1553 	if (code != USBTEST_REQUEST)
1554 		return -EOPNOTSUPP;
1555 
1556 	if (param->iterations <= 0 || param->length < 0
1557 			|| param->sglen < 0 || param->vary < 0)
1558 		return -EINVAL;
1559 
1560 	if (down_interruptible (&dev->sem))
1561 		return -ERESTARTSYS;
1562 
1563 	if (intf->dev.power.power_state.event != PM_EVENT_ON) {
1564 		up (&dev->sem);
1565 		return -EHOSTUNREACH;
1566 	}
1567 
1568 	/* some devices, like ez-usb default devices, need a non-default
1569 	 * altsetting to have any active endpoints.  some tests change
1570 	 * altsettings; force a default so most tests don't need to check.
1571 	 */
1572 	if (dev->info->alt >= 0) {
1573 	    	int	res;
1574 
1575 		if (intf->altsetting->desc.bInterfaceNumber) {
1576 			up (&dev->sem);
1577 			return -ENODEV;
1578 		}
1579 		res = set_altsetting (dev, dev->info->alt);
1580 		if (res) {
1581 			dev_err (&intf->dev,
1582 					"set altsetting to %d failed, %d\n",
1583 					dev->info->alt, res);
1584 			up (&dev->sem);
1585 			return res;
1586 		}
1587 	}
1588 
1589 	/*
1590 	 * Just a bunch of test cases that every HCD is expected to handle.
1591 	 *
1592 	 * Some may need specific firmware, though it'd be good to have
1593 	 * one firmware image to handle all the test cases.
1594 	 *
1595 	 * FIXME add more tests!  cancel requests, verify the data, control
1596 	 * queueing, concurrent read+write threads, and so on.
1597 	 */
1598 	do_gettimeofday (&start);
1599 	switch (param->test_num) {
1600 
1601 	case 0:
1602 		dev_dbg (&intf->dev, "TEST 0:  NOP\n");
1603 		retval = 0;
1604 		break;
1605 
1606 	/* Simple non-queued bulk I/O tests */
1607 	case 1:
1608 		if (dev->out_pipe == 0)
1609 			break;
1610 		dev_dbg (&intf->dev,
1611 				"TEST 1:  write %d bytes %u times\n",
1612 				param->length, param->iterations);
1613 		urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1614 		if (!urb) {
1615 			retval = -ENOMEM;
1616 			break;
1617 		}
1618 		// FIRMWARE:  bulk sink (maybe accepts short writes)
1619 		retval = simple_io (urb, param->iterations, 0, 0, "test1");
1620 		simple_free_urb (urb);
1621 		break;
1622 	case 2:
1623 		if (dev->in_pipe == 0)
1624 			break;
1625 		dev_dbg (&intf->dev,
1626 				"TEST 2:  read %d bytes %u times\n",
1627 				param->length, param->iterations);
1628 		urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1629 		if (!urb) {
1630 			retval = -ENOMEM;
1631 			break;
1632 		}
1633 		// FIRMWARE:  bulk source (maybe generates short writes)
1634 		retval = simple_io (urb, param->iterations, 0, 0, "test2");
1635 		simple_free_urb (urb);
1636 		break;
1637 	case 3:
1638 		if (dev->out_pipe == 0 || param->vary == 0)
1639 			break;
1640 		dev_dbg (&intf->dev,
1641 				"TEST 3:  write/%d 0..%d bytes %u times\n",
1642 				param->vary, param->length, param->iterations);
1643 		urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1644 		if (!urb) {
1645 			retval = -ENOMEM;
1646 			break;
1647 		}
1648 		// FIRMWARE:  bulk sink (maybe accepts short writes)
1649 		retval = simple_io (urb, param->iterations, param->vary,
1650 					0, "test3");
1651 		simple_free_urb (urb);
1652 		break;
1653 	case 4:
1654 		if (dev->in_pipe == 0 || param->vary == 0)
1655 			break;
1656 		dev_dbg (&intf->dev,
1657 				"TEST 4:  read/%d 0..%d bytes %u times\n",
1658 				param->vary, param->length, param->iterations);
1659 		urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1660 		if (!urb) {
1661 			retval = -ENOMEM;
1662 			break;
1663 		}
1664 		// FIRMWARE:  bulk source (maybe generates short writes)
1665 		retval = simple_io (urb, param->iterations, param->vary,
1666 					0, "test4");
1667 		simple_free_urb (urb);
1668 		break;
1669 
1670 	/* Queued bulk I/O tests */
1671 	case 5:
1672 		if (dev->out_pipe == 0 || param->sglen == 0)
1673 			break;
1674 		dev_dbg (&intf->dev,
1675 			"TEST 5:  write %d sglists %d entries of %d bytes\n",
1676 				param->iterations,
1677 				param->sglen, param->length);
1678 		sg = alloc_sglist (param->sglen, param->length, 0);
1679 		if (!sg) {
1680 			retval = -ENOMEM;
1681 			break;
1682 		}
1683 		// FIRMWARE:  bulk sink (maybe accepts short writes)
1684 		retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1685 				&req, sg, param->sglen);
1686 		free_sglist (sg, param->sglen);
1687 		break;
1688 
1689 	case 6:
1690 		if (dev->in_pipe == 0 || param->sglen == 0)
1691 			break;
1692 		dev_dbg (&intf->dev,
1693 			"TEST 6:  read %d sglists %d entries of %d bytes\n",
1694 				param->iterations,
1695 				param->sglen, param->length);
1696 		sg = alloc_sglist (param->sglen, param->length, 0);
1697 		if (!sg) {
1698 			retval = -ENOMEM;
1699 			break;
1700 		}
1701 		// FIRMWARE:  bulk source (maybe generates short writes)
1702 		retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1703 				&req, sg, param->sglen);
1704 		free_sglist (sg, param->sglen);
1705 		break;
1706 	case 7:
1707 		if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1708 			break;
1709 		dev_dbg (&intf->dev,
1710 			"TEST 7:  write/%d %d sglists %d entries 0..%d bytes\n",
1711 				param->vary, param->iterations,
1712 				param->sglen, param->length);
1713 		sg = alloc_sglist (param->sglen, param->length, param->vary);
1714 		if (!sg) {
1715 			retval = -ENOMEM;
1716 			break;
1717 		}
1718 		// FIRMWARE:  bulk sink (maybe accepts short writes)
1719 		retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1720 				&req, sg, param->sglen);
1721 		free_sglist (sg, param->sglen);
1722 		break;
1723 	case 8:
1724 		if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1725 			break;
1726 		dev_dbg (&intf->dev,
1727 			"TEST 8:  read/%d %d sglists %d entries 0..%d bytes\n",
1728 				param->vary, param->iterations,
1729 				param->sglen, param->length);
1730 		sg = alloc_sglist (param->sglen, param->length, param->vary);
1731 		if (!sg) {
1732 			retval = -ENOMEM;
1733 			break;
1734 		}
1735 		// FIRMWARE:  bulk source (maybe generates short writes)
1736 		retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1737 				&req, sg, param->sglen);
1738 		free_sglist (sg, param->sglen);
1739 		break;
1740 
1741 	/* non-queued sanity tests for control (chapter 9 subset) */
1742 	case 9:
1743 		retval = 0;
1744 		dev_dbg (&intf->dev,
1745 			"TEST 9:  ch9 (subset) control tests, %d times\n",
1746 				param->iterations);
1747 		for (i = param->iterations; retval == 0 && i--; /* NOP */)
1748 			retval = ch9_postconfig (dev);
1749 		if (retval)
1750 			dbg ("ch9 subset failed, iterations left %d", i);
1751 		break;
1752 
1753 	/* queued control messaging */
1754 	case 10:
1755 		if (param->sglen == 0)
1756 			break;
1757 		retval = 0;
1758 		dev_dbg (&intf->dev,
1759 				"TEST 10:  queue %d control calls, %d times\n",
1760 				param->sglen,
1761 				param->iterations);
1762 		retval = test_ctrl_queue (dev, param);
1763 		break;
1764 
1765 	/* simple non-queued unlinks (ring with one urb) */
1766 	case 11:
1767 		if (dev->in_pipe == 0 || !param->length)
1768 			break;
1769 		retval = 0;
1770 		dev_dbg (&intf->dev, "TEST 11:  unlink %d reads of %d\n",
1771 				param->iterations, param->length);
1772 		for (i = param->iterations; retval == 0 && i--; /* NOP */)
1773 			retval = unlink_simple (dev, dev->in_pipe,
1774 						param->length);
1775 		if (retval)
1776 			dev_dbg (&intf->dev, "unlink reads failed %d, "
1777 				"iterations left %d\n", retval, i);
1778 		break;
1779 	case 12:
1780 		if (dev->out_pipe == 0 || !param->length)
1781 			break;
1782 		retval = 0;
1783 		dev_dbg (&intf->dev, "TEST 12:  unlink %d writes of %d\n",
1784 				param->iterations, param->length);
1785 		for (i = param->iterations; retval == 0 && i--; /* NOP */)
1786 			retval = unlink_simple (dev, dev->out_pipe,
1787 						param->length);
1788 		if (retval)
1789 			dev_dbg (&intf->dev, "unlink writes failed %d, "
1790 				"iterations left %d\n", retval, i);
1791 		break;
1792 
1793 	/* ep halt tests */
1794 	case 13:
1795 		if (dev->out_pipe == 0 && dev->in_pipe == 0)
1796 			break;
1797 		retval = 0;
1798 		dev_dbg (&intf->dev, "TEST 13:  set/clear %d halts\n",
1799 				param->iterations);
1800 		for (i = param->iterations; retval == 0 && i--; /* NOP */)
1801 			retval = halt_simple (dev);
1802 
1803 		if (retval)
1804 			DBG (dev, "halts failed, iterations left %d\n", i);
1805 		break;
1806 
1807 	/* control write tests */
1808 	case 14:
1809 		if (!dev->info->ctrl_out)
1810 			break;
1811 		dev_dbg (&intf->dev, "TEST 14:  %d ep0out, %d..%d vary %d\n",
1812 				param->iterations,
1813 				realworld ? 1 : 0, param->length,
1814 				param->vary);
1815 		retval = ctrl_out (dev, param->iterations,
1816 				param->length, param->vary);
1817 		break;
1818 
1819 	/* iso write tests */
1820 	case 15:
1821 		if (dev->out_iso_pipe == 0 || param->sglen == 0)
1822 			break;
1823 		dev_dbg (&intf->dev,
1824 			"TEST 15:  write %d iso, %d entries of %d bytes\n",
1825 				param->iterations,
1826 				param->sglen, param->length);
1827 		// FIRMWARE:  iso sink
1828 		retval = test_iso_queue (dev, param,
1829 				dev->out_iso_pipe, dev->iso_out);
1830 		break;
1831 
1832 	/* iso read tests */
1833 	case 16:
1834 		if (dev->in_iso_pipe == 0 || param->sglen == 0)
1835 			break;
1836 		dev_dbg (&intf->dev,
1837 			"TEST 16:  read %d iso, %d entries of %d bytes\n",
1838 				param->iterations,
1839 				param->sglen, param->length);
1840 		// FIRMWARE:  iso source
1841 		retval = test_iso_queue (dev, param,
1842 				dev->in_iso_pipe, dev->iso_in);
1843 		break;
1844 
1845 	// FIXME unlink from queue (ring with N urbs)
1846 
1847 	// FIXME scatterlist cancel (needs helper thread)
1848 
1849 	}
1850 	do_gettimeofday (&param->duration);
1851 	param->duration.tv_sec -= start.tv_sec;
1852 	param->duration.tv_usec -= start.tv_usec;
1853 	if (param->duration.tv_usec < 0) {
1854 		param->duration.tv_usec += 1000 * 1000;
1855 		param->duration.tv_sec -= 1;
1856 	}
1857 	up (&dev->sem);
1858 	return retval;
1859 }
1860 
1861 /*-------------------------------------------------------------------------*/
1862 
1863 static unsigned force_interrupt = 0;
1864 module_param (force_interrupt, uint, 0);
1865 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1866 
1867 #ifdef	GENERIC
1868 static unsigned short vendor;
1869 module_param(vendor, ushort, 0);
1870 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1871 
1872 static unsigned short product;
1873 module_param(product, ushort, 0);
1874 MODULE_PARM_DESC (product, "product code (from vendor)");
1875 #endif
1876 
1877 static int
1878 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1879 {
1880 	struct usb_device	*udev;
1881 	struct usbtest_dev	*dev;
1882 	struct usbtest_info	*info;
1883 	char			*rtest, *wtest;
1884 	char			*irtest, *iwtest;
1885 
1886 	udev = interface_to_usbdev (intf);
1887 
1888 #ifdef	GENERIC
1889 	/* specify devices by module parameters? */
1890 	if (id->match_flags == 0) {
1891 		/* vendor match required, product match optional */
1892 		if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1893 			return -ENODEV;
1894 		if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1895 			return -ENODEV;
1896 		dbg ("matched module params, vend=0x%04x prod=0x%04x",
1897 				le16_to_cpu(udev->descriptor.idVendor),
1898 				le16_to_cpu(udev->descriptor.idProduct));
1899 	}
1900 #endif
1901 
1902 	dev = kzalloc(sizeof(*dev), SLAB_KERNEL);
1903 	if (!dev)
1904 		return -ENOMEM;
1905 	info = (struct usbtest_info *) id->driver_info;
1906 	dev->info = info;
1907 	init_MUTEX (&dev->sem);
1908 
1909 	dev->intf = intf;
1910 
1911 	/* cacheline-aligned scratch for i/o */
1912 	if ((dev->buf = kmalloc (TBUF_SIZE, SLAB_KERNEL)) == NULL) {
1913 		kfree (dev);
1914 		return -ENOMEM;
1915 	}
1916 
1917 	/* NOTE this doesn't yet test the handful of difference that are
1918 	 * visible with high speed interrupts:  bigger maxpacket (1K) and
1919 	 * "high bandwidth" modes (up to 3 packets/uframe).
1920 	 */
1921 	rtest = wtest = "";
1922 	irtest = iwtest = "";
1923 	if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1924 		if (info->ep_in) {
1925 			dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1926 			rtest = " intr-in";
1927 		}
1928 		if (info->ep_out) {
1929 			dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1930 			wtest = " intr-out";
1931 		}
1932 	} else {
1933 		if (info->autoconf) {
1934 			int status;
1935 
1936 			status = get_endpoints (dev, intf);
1937 			if (status < 0) {
1938 				dbg ("couldn't get endpoints, %d\n", status);
1939 				return status;
1940 			}
1941 			/* may find bulk or ISO pipes */
1942 		} else {
1943 			if (info->ep_in)
1944 				dev->in_pipe = usb_rcvbulkpipe (udev,
1945 							info->ep_in);
1946 			if (info->ep_out)
1947 				dev->out_pipe = usb_sndbulkpipe (udev,
1948 							info->ep_out);
1949 		}
1950 		if (dev->in_pipe)
1951 			rtest = " bulk-in";
1952 		if (dev->out_pipe)
1953 			wtest = " bulk-out";
1954 		if (dev->in_iso_pipe)
1955 			irtest = " iso-in";
1956 		if (dev->out_iso_pipe)
1957 			iwtest = " iso-out";
1958 	}
1959 
1960 	usb_set_intfdata (intf, dev);
1961 	dev_info (&intf->dev, "%s\n", info->name);
1962 	dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1963 			({ char *tmp;
1964 			switch (udev->speed) {
1965 			case USB_SPEED_LOW: tmp = "low"; break;
1966 			case USB_SPEED_FULL: tmp = "full"; break;
1967 			case USB_SPEED_HIGH: tmp = "high"; break;
1968 			default: tmp = "unknown"; break;
1969 			}; tmp; }),
1970 			info->ctrl_out ? " in/out" : "",
1971 			rtest, wtest,
1972 			irtest, iwtest,
1973 			info->alt >= 0 ? " (+alt)" : "");
1974 	return 0;
1975 }
1976 
1977 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1978 {
1979 	return 0;
1980 }
1981 
1982 static int usbtest_resume (struct usb_interface *intf)
1983 {
1984 	return 0;
1985 }
1986 
1987 
1988 static void usbtest_disconnect (struct usb_interface *intf)
1989 {
1990 	struct usbtest_dev	*dev = usb_get_intfdata (intf);
1991 
1992 	down (&dev->sem);
1993 
1994 	usb_set_intfdata (intf, NULL);
1995 	dev_dbg (&intf->dev, "disconnect\n");
1996 	kfree (dev);
1997 }
1998 
1999 /* Basic testing only needs a device that can source or sink bulk traffic.
2000  * Any device can test control transfers (default with GENERIC binding).
2001  *
2002  * Several entries work with the default EP0 implementation that's built
2003  * into EZ-USB chips.  There's a default vendor ID which can be overridden
2004  * by (very) small config EEPROMS, but otherwise all these devices act
2005  * identically until firmware is loaded:  only EP0 works.  It turns out
2006  * to be easy to make other endpoints work, without modifying that EP0
2007  * behavior.  For now, we expect that kind of firmware.
2008  */
2009 
2010 /* an21xx or fx versions of ez-usb */
2011 static struct usbtest_info ez1_info = {
2012 	.name		= "EZ-USB device",
2013 	.ep_in		= 2,
2014 	.ep_out		= 2,
2015 	.alt		= 1,
2016 };
2017 
2018 /* fx2 version of ez-usb */
2019 static struct usbtest_info ez2_info = {
2020 	.name		= "FX2 device",
2021 	.ep_in		= 6,
2022 	.ep_out		= 2,
2023 	.alt		= 1,
2024 };
2025 
2026 /* ezusb family device with dedicated usb test firmware,
2027  */
2028 static struct usbtest_info fw_info = {
2029 	.name		= "usb test device",
2030 	.ep_in		= 2,
2031 	.ep_out		= 2,
2032 	.alt		= 1,
2033 	.autoconf	= 1,		// iso and ctrl_out need autoconf
2034 	.ctrl_out	= 1,
2035 	.iso		= 1,		// iso_ep's are #8 in/out
2036 };
2037 
2038 /* peripheral running Linux and 'zero.c' test firmware, or
2039  * its user-mode cousin. different versions of this use
2040  * different hardware with the same vendor/product codes.
2041  * host side MUST rely on the endpoint descriptors.
2042  */
2043 static struct usbtest_info gz_info = {
2044 	.name		= "Linux gadget zero",
2045 	.autoconf	= 1,
2046 	.ctrl_out	= 1,
2047 	.alt		= 0,
2048 };
2049 
2050 static struct usbtest_info um_info = {
2051 	.name		= "Linux user mode test driver",
2052 	.autoconf	= 1,
2053 	.alt		= -1,
2054 };
2055 
2056 static struct usbtest_info um2_info = {
2057 	.name		= "Linux user mode ISO test driver",
2058 	.autoconf	= 1,
2059 	.iso		= 1,
2060 	.alt		= -1,
2061 };
2062 
2063 #ifdef IBOT2
2064 /* this is a nice source of high speed bulk data;
2065  * uses an FX2, with firmware provided in the device
2066  */
2067 static struct usbtest_info ibot2_info = {
2068 	.name		= "iBOT2 webcam",
2069 	.ep_in		= 2,
2070 	.alt		= -1,
2071 };
2072 #endif
2073 
2074 #ifdef GENERIC
2075 /* we can use any device to test control traffic */
2076 static struct usbtest_info generic_info = {
2077 	.name		= "Generic USB device",
2078 	.alt		= -1,
2079 };
2080 #endif
2081 
2082 // FIXME remove this
2083 static struct usbtest_info hact_info = {
2084 	.name		= "FX2/hact",
2085 	//.ep_in		= 6,
2086 	.ep_out		= 2,
2087 	.alt		= -1,
2088 };
2089 
2090 
2091 static struct usb_device_id id_table [] = {
2092 
2093 	{ USB_DEVICE (0x0547, 0x1002),
2094 		.driver_info = (unsigned long) &hact_info,
2095 		},
2096 
2097 	/*-------------------------------------------------------------*/
2098 
2099 	/* EZ-USB devices which download firmware to replace (or in our
2100 	 * case augment) the default device implementation.
2101 	 */
2102 
2103 	/* generic EZ-USB FX controller */
2104 	{ USB_DEVICE (0x0547, 0x2235),
2105 		.driver_info = (unsigned long) &ez1_info,
2106 		},
2107 
2108 	/* CY3671 development board with EZ-USB FX */
2109 	{ USB_DEVICE (0x0547, 0x0080),
2110 		.driver_info = (unsigned long) &ez1_info,
2111 		},
2112 
2113 	/* generic EZ-USB FX2 controller (or development board) */
2114 	{ USB_DEVICE (0x04b4, 0x8613),
2115 		.driver_info = (unsigned long) &ez2_info,
2116 		},
2117 
2118 	/* re-enumerated usb test device firmware */
2119 	{ USB_DEVICE (0xfff0, 0xfff0),
2120 		.driver_info = (unsigned long) &fw_info,
2121 		},
2122 
2123 	/* "Gadget Zero" firmware runs under Linux */
2124 	{ USB_DEVICE (0x0525, 0xa4a0),
2125 		.driver_info = (unsigned long) &gz_info,
2126 		},
2127 
2128 	/* so does a user-mode variant */
2129 	{ USB_DEVICE (0x0525, 0xa4a4),
2130 		.driver_info = (unsigned long) &um_info,
2131 		},
2132 
2133 	/* ... and a user-mode variant that talks iso */
2134 	{ USB_DEVICE (0x0525, 0xa4a3),
2135 		.driver_info = (unsigned long) &um2_info,
2136 		},
2137 
2138 #ifdef KEYSPAN_19Qi
2139 	/* Keyspan 19qi uses an21xx (original EZ-USB) */
2140 	// this does not coexist with the real Keyspan 19qi driver!
2141 	{ USB_DEVICE (0x06cd, 0x010b),
2142 		.driver_info = (unsigned long) &ez1_info,
2143 		},
2144 #endif
2145 
2146 	/*-------------------------------------------------------------*/
2147 
2148 #ifdef IBOT2
2149 	/* iBOT2 makes a nice source of high speed bulk-in data */
2150 	// this does not coexist with a real iBOT2 driver!
2151 	{ USB_DEVICE (0x0b62, 0x0059),
2152 		.driver_info = (unsigned long) &ibot2_info,
2153 		},
2154 #endif
2155 
2156 	/*-------------------------------------------------------------*/
2157 
2158 #ifdef GENERIC
2159 	/* module params can specify devices to use for control tests */
2160 	{ .driver_info = (unsigned long) &generic_info, },
2161 #endif
2162 
2163 	/*-------------------------------------------------------------*/
2164 
2165 	{ }
2166 };
2167 MODULE_DEVICE_TABLE (usb, id_table);
2168 
2169 static struct usb_driver usbtest_driver = {
2170 	.name =		"usbtest",
2171 	.id_table =	id_table,
2172 	.probe =	usbtest_probe,
2173 	.ioctl =	usbtest_ioctl,
2174 	.disconnect =	usbtest_disconnect,
2175 	.suspend =	usbtest_suspend,
2176 	.resume =	usbtest_resume,
2177 };
2178 
2179 /*-------------------------------------------------------------------------*/
2180 
2181 static int __init usbtest_init (void)
2182 {
2183 #ifdef GENERIC
2184 	if (vendor)
2185 		dbg ("params: vend=0x%04x prod=0x%04x", vendor, product);
2186 #endif
2187 	return usb_register (&usbtest_driver);
2188 }
2189 module_init (usbtest_init);
2190 
2191 static void __exit usbtest_exit (void)
2192 {
2193 	usb_deregister (&usbtest_driver);
2194 }
2195 module_exit (usbtest_exit);
2196 
2197 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2198 MODULE_LICENSE ("GPL");
2199 
2200