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