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