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