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