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